Skip to content

Support profile-based changelog bundle --release-date option#3560

Draft
lcawl wants to merge 1 commit into
changelog-bundle-cli-optionsfrom
changelog-bundle-profile-dates
Draft

Support profile-based changelog bundle --release-date option#3560
lcawl wants to merge 1 commit into
changelog-bundle-cli-optionsfrom
changelog-bundle-profile-dates

Conversation

@lcawl

@lcawl lcawl commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Background

The changelog bundle command currently generates release-date info in the bundle (as long as the release_dates configuration 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-date in profile-based changelog bundle commands.
Keep --no-release-date unsupported in profile-based commands (YAML release_dates: false remains the config path).

Precedence (document + test)

Input Result
--release-date 2026-06-23 Writes that date
No CLI date, release_dates: false No release-date in bundle
No CLI date, release_dates: true (default) Auto UTC today if bundle has no existing date

Code

ChangelogCommand.cs

  • --release-date is allowed in profile-based commands; --no-release-date remains forbidden.
  • Updated <remarks> to document [--release-date YYYY-MM-DD] alongside --plan, plus precedence (config suppresses auto-population; CLI override wins).
  • Updated releaseDate param summary to mark it as supported in profile mode.

docs/cli-schema.json

  • Updated synced notes and release-date parameter summary with the XML doc changes

BundleChangelogsTests.cs

Three new profile-mode service tests:

  1. BundleChangelogs_WithProfile_ExplicitReleaseDate_WritesDate — profile + explicit date writes 2026-06-23
  2. BundleChangelogs_WithProfile_ReleaseDatesFalseAndExplicitReleaseDate_WritesDaterelease_dates: false + CLI date still writes the date
  3. BundleChangelogs_WithProfile_ReleaseDatesFalse_SuppressesReleaseDaterelease_dates: false with no CLI date omits release-date

No changes to ChangelogBundlingService (already honours input.ReleaseDate) or docs/syntax/changelog.md.

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-2.5-fast

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.

1 participant