Skip to content

Commit bf2ba51

Browse files
authored
Update usage.md
1 parent b42bde5 commit bf2ba51

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/usage.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,17 @@ $ elastic-agent-changelog-tool build --version=next --owner <owner> --repo <repo
4242
the render the consolidated changelog with:
4343

4444
```
45-
$ $ elastic-agent-changelog-tool render --version=next --owner <owner> --repo <repo>
45+
$ elastic-agent-changelog-tool render --version=next --owner <owner> --repo <repo>
4646
```
4747

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

50+
### My PR does not need a changelog
51+
52+
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.
53+
54+
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.
55+
5056
## I'm a maintainer
5157

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

0 commit comments

Comments
 (0)