Skip to content

build(release): generate GitHub release notes - #455

Merged
thomhurst merged 2 commits into
mainfrom
issue-425-release-notes
Aug 28, 2026
Merged

build(release): generate GitHub release notes#455
thomhurst merged 2 commits into
mainfrom
issue-425-release-notes

Conversation

@thomhurst

Copy link
Copy Markdown
Owner

Closes #425

What changed

  • replaced CHANGELOG-based release bodies with GitHub-generated notes categorized by existing labels
  • added a dry-run preview and retry-safe regeneration for existing releases
  • removed CHANGELOG extraction/verification and moved dead pre-release API linting into Verify-Docs.ps1
  • moved the 1.0 migration narrative and corrected rename table into a dedicated upgrading guide
  • pointed README and NuGet package release-note metadata at GitHub Releases

Why

The hand-maintained changelog was already stale and release publication depended on it. Merged PRs are the authoritative audit trail; GitHub-generated notes keep that trail complete while the dedicated upgrade guide preserves curated migration guidance.

Validation

  • pwsh scripts/Verify-ReleaseWorkflow.ps1
  • pwsh scripts/Verify-ReleaseApiBaselines.ps1 -Version 1.0.0
  • dotnet pack Kevlar.slnx -c Release
  • pwsh scripts/Verify-Packages.ps1 -PackagesPath artifacts/package/release -Version 0.0.0-local
  • pwsh scripts/Verify-Docs.ps1
  • pwsh scripts/Verify-Repo.ps1
  • pwsh scripts/Verify-DocSnippets.ps1 -PackagesPath artifacts/package/release -Version 0.0.0-local -NoImplicitUsings (isolated NuGet cache)
  • npm run build under docs/
  • Publish-GitHubRelease.ps1 -DryRun generated a categorized v1.0.0 body from v0.10.0
  • injected RetryNumber fixture was rejected by Verify-Docs.ps1

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 27f8520a-3d9a-4271-9902-6e40321ce5f0


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ac51045b8c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread scripts/Publish-GitHubRelease.ps1 Outdated
Replace stale CHANGELOG-driven release bodies with categorized GitHub-generated notes while preserving the 1.0 migration narrative in the documentation.
@thomhurst
thomhurst force-pushed the issue-425-release-notes branch from 934d93f to b041add Compare August 28, 2026 00:44
@thomhurst
thomhurst merged commit d2d06e5 into main Aug 28, 2026
7 checks passed
@thomhurst
thomhurst deleted the issue-425-release-notes branch August 28, 2026 01:04
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.

release: replace CHANGELOG-driven notes with GitHub auto-generated release notes

1 participant