Skip to content

Generate release notes from changelog#267

Merged
NathanLovato merged 2 commits into
GDQuest:mainfrom
DevTwilight:release-notes-gen
Jul 14, 2026
Merged

Generate release notes from changelog#267
NathanLovato merged 2 commits into
GDQuest:mainfrom
DevTwilight:release-notes-gen

Conversation

@DevTwilight

Copy link
Copy Markdown
Contributor

Please check if the PR fulfills these requirements:

  • The commit message follows our guidelines.
  • For bug fixes and features:
    • The changes were tested.

Related issue (if applicable): #

What kind of change does this PR introduce?

This PR updates the release workflow to generate GitHub release notes from the latest entry in CHANGELOG.md.

Does this PR introduce a breaking change?

No.

New feature or change

  • Added .github/generate_release_notes.py to extract the latest changelog entry.
  • Updated the release workflow to generate release-notes.md before creating a release.
  • Changed the release creation step to use --notes-file instead of hardcoded release notes.

What is the current behavior?

The release workflow uses manually written release notes embedded directly in the GitHub Actions workflow. Changes documented in CHANGELOG.md are not automatically included in GitHub releases.

What is the new behavior?

The release workflow generates release notes from the latest CHANGELOG.md entry and uses them when creating the GitHub release.

This assumes CHANGELOG.md has been updated with the release notes before the release workflow is triggered.

Other information

This keeps GitHub releases synchronized with the changelog and removes the need to manually update release notes in the workflow.

@NathanLovato NathanLovato merged commit d2ddca2 into GDQuest:main Jul 14, 2026
1 check passed
@NathanLovato

Copy link
Copy Markdown
Contributor

Thank you!

@DevTwilight

Copy link
Copy Markdown
Contributor Author

i hope this will add some value

@DevTwilight DevTwilight deleted the release-notes-gen branch July 14, 2026 08:38
@NathanLovato

Copy link
Copy Markdown
Contributor

Yes, thank you for taking the time to contribute.

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.

2 participants