Create release notes from changelogs

By adding a file for each notable change in your GitHub repository and grouping the files into bundles, you can ultimately generate release documentation with a consistent layout for all your products.

To use the docs-builder changelog commands in your development workflow:

1. Configure changelogs: Create a configuration file, map labels, and define rules for creation and bundling.
2. Create changelogs with the docs-builder changelog add command.
   • Alternatively, if you already have automated release notes for GitHub releases, you can use the docs-builder changelog gh-release command to create changelog files and a bundle from your GitHub release notes. Refer to changelog gh-release.
3. Bundle changelogs with the docs-builder changelog bundle command. For example, create a bundle for the pull requests that are included in a product release. When changelogs are no longer needed in the repo, remove changelog files with docs-builder changelog remove.
4. Publish release notes: Use the {changelog} directive in docs or docs-builder changelog render to produce release documentation.

For more information about running docs-builder, go to Contribute locally.