Enhance changelog add command with github release workflow#2842
Open
Enhance changelog add command with github release workflow#2842
Conversation
🔍 Preview links for changed docs |
reakaleek
approved these changes
Mar 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Per #2841, the
docs-builder changelog gh-releasecommand creates both changelog files and a bundle from a GitHub release. This PR enhances thedocs-builder changelog addcommand 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— addedCreateBundleproperty toCreateChangelogsFromReleaseArguments(defaultstrue); bundle creation is now gated on itsrc/tooling/docs-builder/Commands/ChangelogCommand.cs— added--release-versionparameter tochangelog add; when set, validates mutual exclusivity with--prs/--issuesand requirement of--repo, then delegates toGitHubReleaseChangelogServicewithCreateBundle = falsedocs/cli/release/changelog-add.md— documented--release-versionoption and updated--repodescriptiondocs/contribute/changelog.md— added "Create changelogs from a release" subsection with example; updated Authorization note to include--release-versiontests/Elastic.Changelog.Tests/Changelogs/Create/ReleaseVersionTests.cs(new) — 6 tests covering: no PR refs warning, changelog files created without bundle, bundle created whenCreateBundle = true,latesttag pass-through, fetch failure error, and unknown repo errorAll 244 tests pass.
Generative AI disclosure
Tool(s) and model(s) used: composer-1.5, clause-4.6-sonnet-medium