diff --git a/docs/usage.md b/docs/usage.md index 9253b40..34a050a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -31,7 +31,7 @@ You must edit the created file compiling all uncommented fields and optionally u The fragment is created from the template available in [`../internal/changelog/fragment/template.yaml`](../internal/changelog/fragment/template.yaml). -### Viewing the changelog +### Previewing the changelog From the repository root folder build the consolidated changelog with: @@ -65,7 +65,7 @@ Given a PR number this command checks for presence of an added Changelog Fragmen For futrher details look at command usage: `elastic-agent-changelog-tool pr-has-fragment --help` -### Viewing the changelog +### Previewing the changelog From the repository root folder build the consolidated changelog with: @@ -81,6 +81,19 @@ $ $ elastic-agent-changelog-tool render --version=next --owner --repo --owner --repo `; +* This will create `./changelog/x.y.z.yaml`; +2. Create rendered changelog with `$ elastic-agent-changelog-tool render --version `; +* This will generate an asciidoc file in the `changelog/` directory; +3. Use the rendered changelog. + +**Note**: we do not remove fragments, as they will be needed for the stable release version changelog. + ## I'm the release manager > NOTE: This instructions are for the 0.2.0 milestone (when ready). As more features and automation is added the process will become simpler.