Skip to content

Enhance changelog add command with github release workflow#2842

Open
lcawl wants to merge 1 commit intomainfrom
feat/changelog-add-release-version
Open

Enhance changelog add command with github release workflow#2842
lcawl wants to merge 1 commit intomainfrom
feat/changelog-add-release-version

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 3, 2026

Summary

Per #2841, the docs-builder changelog gh-release command creates both changelog files and a bundle from a GitHub release. This PR enhances the docs-builder changelog add command to also be able to do just the first half of that functionality, in case teams want to separate the tasks. For example, maybe there's a case where they want to create all the changelogs but bundle later (or use exceptional bundle commands). (The use case here isn't as obvious as the upcoming "bundle" one, but IMO it doesn't hurt to have both split out).

Files changed

  • src/services/Elastic.Changelog/GithubRelease/GitHubReleaseChangelogService.cs — added CreateBundle property to CreateChangelogsFromReleaseArguments (defaults true); bundle creation is now gated on it

  • src/tooling/docs-builder/Commands/ChangelogCommand.cs — added --release-version parameter to changelog add; when set, validates mutual exclusivity with --prs/--issues and requirement of --repo, then delegates to GitHubReleaseChangelogService with CreateBundle = false

  • docs/cli/release/changelog-add.md — documented --release-version option and updated --repo description

  • docs/contribute/changelog.md — added "Create changelogs from a release" subsection with example; updated Authorization note to include --release-version

  • tests/Elastic.Changelog.Tests/Changelogs/Create/ReleaseVersionTests.cs (new) — 6 tests covering: no PR refs warning, changelog files created without bundle, bundle created when CreateBundle = true, latest tag pass-through, fetch failure error, and unknown repo error

All 244 tests pass.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: composer-1.5, clause-4.6-sonnet-medium

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

🔍 Preview links for changed docs

@lcawl lcawl marked this pull request as ready for review March 3, 2026 18:18
@lcawl lcawl requested review from a team as code owners March 3, 2026 18:18
@lcawl lcawl requested a review from cotti March 3, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants