Support profile-based changelog bundle --release-date option#3560
Draft
lcawl wants to merge 1 commit into
Draft
Conversation
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.
Background
The
changelog bundlecommand currently generatesrelease-dateinfo in the bundle (as long as therelease_datesconfiguration setting is not set to false).When you're using profiles to generate bundles in a repeated fashion, it uses the "current" date, which is problematic for cases where we need to re-generate bundles after the official release date.
The current work-around is to manually edit the date field in the bundle.
Goal
Allow
--release-datein profile-basedchangelog bundlecommands.Keep
--no-release-dateunsupported in profile-based commands (YAMLrelease_dates: falseremains the config path).Precedence (document + test)
--release-date 2026-06-23release_dates: falserelease-datein bundlerelease_dates: true(default)Code
ChangelogCommand.cs--release-dateis allowed in profile-based commands;--no-release-dateremains forbidden.<remarks>to document[--release-date YYYY-MM-DD]alongside--plan, plus precedence (config suppresses auto-population; CLI override wins).releaseDateparam summary to mark it as supported in profile mode.docs/cli-schema.jsonnotesandrelease-dateparameter summary with the XML doc changesBundleChangelogsTests.csThree new profile-mode service tests:
BundleChangelogs_WithProfile_ExplicitReleaseDate_WritesDate— profile + explicit date writes2026-06-23BundleChangelogs_WithProfile_ReleaseDatesFalseAndExplicitReleaseDate_WritesDate—release_dates: false+ CLI date still writes the dateBundleChangelogs_WithProfile_ReleaseDatesFalse_SuppressesReleaseDate—release_dates: falsewith no CLI date omitsrelease-dateNo changes to
ChangelogBundlingService(already honoursinput.ReleaseDate) ordocs/syntax/changelog.md.Generative AI disclosure
Tool(s) and model(s) used: composer-2.5-fast