Release notes

docs-builder provides a changelog-based system for creating structured release documentation. Teams author individual changelog entries as they work, and docs-builder bundles them into polished release notes pages.

The release notes workflow has four steps:

Set up changelog configuration in your repository's docset.yml. This defines changelog categories (breaking changes, deprecations, enhancements, bug fixes), version patterns, and output structure.

See configure changelogs for setup details.

Authors create individual changelog entry files as part of their normal development workflow. Each entry is a small YAML file describing the change, its category, and any relevant metadata.

See create changelogs for the entry format.

At release time, changelog entries are bundled into versioned release notes. The bundling process aggregates entries by category and version, producing structured Markdown output.

See bundle changelogs for the bundling process.

Bundled release notes are published as part of the documentation site. The publish step can be automated through CI workflows.

See publish changelogs for deployment details.