Skip to content

Improve release notes workflow - #5

Merged
nleononline merged 1 commit into
masterfrom
agent/improve-release-notes
Jul 27, 2026
Merged

Improve release notes workflow#5
nleononline merged 1 commit into
masterfrom
agent/improve-release-notes

Conversation

@nleononline

Copy link
Copy Markdown
Owner

What changed

  • added explanatory, versioned release notes for v0.1.0
  • added a reusable release-notes template focused on the problem, meaningful changes, and user impact
  • replaced GitHub's auto-generated PR list with the matching versioned notes file
  • added CI validation for missing, empty, or unedited release notes
  • corrected the release instructions in CONTRIBUTING.md

Why

The previous workflow used gh release create --generate-notes, which reduced each release to pull-request titles and contributors. Versioned notes make the release description intentional, informative, reviewable, and reproducible.

Impact

Future releases cannot publish unless their matching notes file exists and no longer contains the template marker. Runtime plugin behavior is unchanged.

Checks

  • git diff --cached --check
  • workflow YAML parsed with Ruby/Psych
  • versioned release-notes validation executed locally
  • GitHub Actions release matrix

@nleononline
nleononline marked this pull request as ready for review July 27, 2026 22:59
@nleononline
nleononline merged commit 09217e7 into master Jul 27, 2026
12 checks passed
@nleononline
nleononline deleted the agent/improve-release-notes branch July 27, 2026 22:59
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