﻿---
title: Release notes
description: docs-builder provides a changelog-based system for creating structured release documentation. Teams author individual changelog entries as they work,...
url: https://docs-v3-preview.elastic.dev/docs-builder/data/release-notes
products:
  - Elastic Docs Builder
---

# 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.

## Workflow

The release notes workflow has four steps:

### 1. Configure

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](https://docs-v3-preview.elastic.dev/docs-builder/data/release-notes/configure) for setup details.

### 2. Create changelogs

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](https://docs-v3-preview.elastic.dev/docs-builder/data/release-notes/create) for the entry format.

### 3. Bundle

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](https://docs-v3-preview.elastic.dev/docs-builder/data/release-notes/bundle) for the bundling process.

### 4. Publish

Bundled release notes are published as part of the documentation site. The publish step can be automated through CI workflows.
See [publish changelogs](https://docs-v3-preview.elastic.dev/docs-builder/data/release-notes/publish) for deployment details.

## Release Notes Explorer

<page-card>
  A web UI for browsing release notes across products — coming soon.
</page-card>