﻿---
title: changelog cli namespace
description: The changelog commands manage a file-per-change workflow that produces release notes with a consistent layout across all your products. Each developer...
url: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2927/cli/changelog
products:
  - Elastic Docs Builder
---

# changelog cli namespace
```bash
docs-builder changelog --help
```

The `changelog` commands manage a file-per-change workflow that produces release notes with a consistent layout across all your products. Each developer creates a small YAML file per pull request; you later bundle those files into a release artifact and render it into Markdown or AsciiDoc.

## Typical workflow

1. **Configure** — create `docs/changelog.yml` with label mappings and bundle profiles: `docs-builder changelog init`
2. **Create** — add a changelog YAML for each notable PR: `docs-builder changelog add`
3. **Bundle** — aggregate entries for a release: `docs-builder changelog bundle`
4. **Publish** — render the bundle to a release notes page: `docs-builder changelog render`

When working in CI, `docs-builder changelog evaluate-pr` inspects an open pull request and decides whether it needs a changelog file, then sets GitHub Actions outputs so your workflow can gate on the result.
See [Create release notes from changelogs](https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/2927/contribute/changelog) for the end-to-end guide.

## Commands

<page-card>
  Create a new changelog entry YAML file.
</page-card>

<page-card>
  Aggregate changelog entries matching a filter into a single bundle YAML.
</page-card>

<page-card>
  Append additional changelog entries to a published bundle without modifying it.
</page-card>

<page-card>
  (CI) Evaluate downloaded artifact in the resolving workflow.
</page-card>

<page-card>
  (CI) Evaluate a pull request for changelog generation eligibility and set GitHub Actions outputs.
</page-card>

<page-card>
  Create changelog entries from the PRs referenced in a GitHub release.
</page-card>

<page-card>
  Create changelog.yml and the changelog/releases directory structure.
</page-card>

<page-card>
  (CI) Package changelog artifact for cross-workflow transfer.
</page-card>

<page-card>
  Delete changelog entry files matching a filter.
</page-card>

<page-card>
  Render one or more changelog bundles to Markdown or AsciiDoc.
</page-card>

<page-card>
  Upload changelog entries or bundle artifacts to S3 or Elasticsearch.
</page-card>