diff --git a/docs/usage.md b/docs/usage.md index 8268f33..9253b40 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -42,11 +42,17 @@ $ elastic-agent-changelog-tool build --version=next --owner --repo --repo +$ elastic-agent-changelog-tool render --version=next --owner --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.