Skip to content

Generate release notes from the changelog - #13

Merged
FaulMit merged 1 commit into
mainfrom
agent/release-notes
Aug 2, 2026
Merged

Generate release notes from the changelog#13
FaulMit merged 1 commit into
mainfrom
agent/release-notes

Conversation

@FaulMit

@FaulMit FaulMit commented Aug 2, 2026

Copy link
Copy Markdown
Owner

What changed

  • use each version section in CHANGELOG.md as the source for GitHub Release descriptions
  • stop release publication when the requested changelog section is missing or empty
  • remove the generated pull-request dump from future release notes
  • add a user-facing release-note writing guide and local preview command
  • document the complete maintainer workflow
  • restore the missing Captail 0.1.4 changelog section

Why

Previous releases combined a repeated package warning with GitHub's generated pull-request list. Important features, fixes, and upgrade actions were difficult to find. Future releases now publish reviewed user-facing notes from the changelog.

User and maintainer impact

Users receive categorized notes focused on behavior and required actions. Maintainers prepare one versioned changelog section, preview it locally, merge it, and run the existing release workflow.

Validation

  • generated and inspected descriptions for versions 0.1.0 through 0.1.5
  • verified missing and empty version sections fail closed
  • parsed the PowerShell generator without syntax errors
  • linted .github/workflows/release.yml with actionlint 1.7.12
  • parsed workflow YAML with PyYAML
  • rendered all six published release descriptions through GitHub's GFM API
  • confirmed the v0.1.4 editor image exists at its release tag
  • git diff --check

@FaulMit
FaulMit marked this pull request as ready for review August 2, 2026 22:32
@FaulMit
FaulMit merged commit 722b76e into main Aug 2, 2026
5 of 6 checks 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.

1 participant