Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
endorama committed Sep 14, 2022
1 parent b42bde5 commit bf2ba51
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,17 @@ $ elastic-agent-changelog-tool build --version=next --owner <owner> --repo <repo
the render the consolidated changelog with:

```
$ $ elastic-agent-changelog-tool render --version=next --owner <owner> --repo <repo>
$ elastic-agent-changelog-tool render --version=next --owner <owner> --repo <repo>
```

An example is [`../changelog/0.1.0.yaml`](../changelog/0.1.0.yaml).

### My PR does not need a changelog

Repositories using this tool are expected to leverage the `pr-has-fragment` command to validate presence of a Changelog Fragment in a Pull Requests. The command can be configured to validate PRs without a Changelog Fragment but labelled with specific labels.

At this moment adding a label named `skip-changelog` or `backport` to a PR will skip the validation, allowing the labelled PR not to contain a Changelog Fragment.

## I'm a maintainer

As a maintainer you are responsible for ensureing **changelog fragments** are present in Pull Requests.
Expand Down

0 comments on commit bf2ba51

Please sign in to comment.