Skip to content

Add CHANGELOG.md and populate PackageReleaseNotes for upgrade evaluation - #15

Merged
Romain-OD merged 2 commits into
mainfrom
copilot/add-changelog-md-and-populate-packagereleasenotes
Oct 20, 2026
Merged

Romain-OD merged 2 commits into
mainfrom
copilot/add-changelog-md-and-populate-packagereleasenotes

Conversation

Copilot AI commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Adopters deciding whether to upgrade from 2.0.0 to 2.1.0 had no changelog and empty <PackageReleaseNotes> on every NuGet.org listing — the place the upgrade decision is actually made. This adds both.

Changes

CHANGELOG.md (new, repo root) — Keep a Changelog 1.1.0, backfilled for both shipped releases:

  • 2.0.0 — flags the middleware-pipeline refactor as Breaking; notes the new NatsNet/AzureEventHubs adapters and the net8.0 + net10.0 multi-targeting.
  • 2.1.0 — the new ImmediateValidations adapter.
  • Every entry names the package(s) it touches, including an explicit "version bump only" note for the packages a release leaves untouched — so a consumer of, say, only MessageValidation.RabbitMQ can tell a co-versioned bump does not affect them.
  • Ends with [Unreleased] + compare links; a header comment records the convention to update the changelog before tagging.

<PackageReleaseNotes> — one line added to all 10 packable .csproj:

<PackageReleaseNotes>https://github.com/Romain-OD/MessageValidation/blob/main/CHANGELOG.md</PackageReleaseNotes>

Note

Applied per-.csproj rather than via Directory.Build.props. The central-properties change (PR #12) is still unmerged; introducing Directory.Build.props here would duplicate and conflict with it. This keeps both PRs independently mergeable — whichever lands second can hoist the line centrally.

Verified: dotnet pack -c Release produces all 10 .nupkg, each .nuspec carrying the <releaseNotes> URL.

…projects

Co-authored-by: Romain-OD <31764259+Romain-OD@users.noreply.github.com>
Copilot AI changed the title [WIP] Add CHANGELOG.md and populate PackageReleaseNotes for upgrade evaluation Add CHANGELOG.md and populate PackageReleaseNotes for upgrade evaluation Oct 14, 2026
Copilot AI requested a review from Romain-OD October 14, 2026 16:18
@Romain-OD
Romain-OD marked this pull request as ready for review October 20, 2026 16:02
@Romain-OD
Romain-OD merged commit af9b7cf into main Oct 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CHANGELOG.md and populate PackageReleaseNotes so adopters can evaluate upgrades

2 participants