Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 5, 2026

Relates to elastic/docs-builder#2350

Summary

This PR adds a changelog configuration file, which contains things like the label to area mappings that will affect the creation of release notes per https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/changelog

The label mappings were derived from:

Examples

To test the use of this configuration file:

  1. Install docs-builder.

  2. Run the docs-builder changelog add command to generate changelogs for a PR that uses the type and area labels that are included in the changelog.yml. For example:

    docs-builder changelog add --pr https://github.com/elastic/kibana/pull/247465  \
      --products "kibana 9.3.0" \
      --config ./kibana/docs/changelog.yml \
      --output ./kibana/docs/changelog
  3. Check out Add PR label blockers to changelog creation docs-builder#2350 then refresh the docs-builder binaries per the readme:

    ./build.sh clean
    ./build.sh publishbinaries
  4. Uncomment the add_blockers section of the changelog.yml file.

  5. Run the docs-builder changelog add command to generate changelogs for one or more pull requests. For example, from the .artifacts/publish/docs-builder/release in the docs-builder repo:

    ./docs-builder changelog add --prs 247707,247465,246788  --repo kibana --owner elastic --products "kibana 9.3.0" --config ~/path/to/kibana/docs/changelog.yml --output ~/path/to/kibana/docs/changelog

    Re-comment the add_blockers section (unless that PR gets merged).

  6. Checkout Add changelog bundle and render commands docs-builder#2341 then refresh the docs-builder binaries (per earlier step).

  7. Uncomment the render_blockers section of the changelog.yml file.

  8. Run the docs-builder changelog bundle and docs-builder changelog render commands to generate docs that heed the render_blockers config. For example, from the .artifacts/publish/docs-builder/release in the docs-builder repo:

    ./docs-builder changelog bundle --directory ~/path/to/kibana/docs/changelog --all
    ./docs-builder changelog render --input ~/path/to/kibana/docs/changelog/changelog-bundle.yaml --output ~/path/to/kibana/docs/release-notes/_snippets

@lcawl lcawl added Team:Docs release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Jan 5, 2026
@elasticmachine
Copy link
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!
  • Click to trigger kibana-deploy-cloud-from-pr for this PR!
  • Click to trigger kibana-entity-store-performance-from-pr for this PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants