Skip to content

ci: draft release notes per release branch from PR titles - #655

Merged
jeremyprime merged 4 commits into
valkey-io:mainfrom
jeremyprime:auto-release-notes
Nov 18, 2026
Merged

jeremyprime merged 4 commits into
valkey-io:mainfrom
jeremyprime:auto-release-notes

Conversation

@jeremyprime

@jeremyprime jeremyprime commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Drafts GitHub release notes from PR titles, using the shared config and workflows added to valkey-glide in valkey-io/valkey-glide#7770. Each release-X.Y branch keeps a draft of its next version, updated on every merge. To release, add a short overview to the draft and publish it on the tag.

Related PRs:

Issue Link

Part of valkey-io/valkey-glide#6405

Features and Behaviour Changes

  • PR titles must follow type(scope): description with a lowercase type. The new pr-title / Validate PR title check enforces it, and Dependabot PRs are exempt.
  • Release-note sections come from the title type: ! → Breaking Changes, feat → Features, fix → Bug Fixes, perf → Performance. docs, ci, build, test, chore, refactor and style are left out, and anything else lands in Other Changes. Add skip-changelog to leave a PR out.
  • Release notes use the shared sections in place of the current emoji headers. Section titles can be overridden in this repo's .github/release-drafter.yml if wanted.

Implementation

  • .github/release-drafter.yml: _extends the valkey-glide config.
  • .github/workflows/pr-title.yml and .github/workflows/draft-release.yml: call the valkey-glide workflows @main, as semgrep.yml and git-secrets-scan.yml do.
  • CONTRIBUTING.md: PR titles now use Conventional Commits too. It previously said plain English, but every human-authored PR merged since September already uses the format.
  • PR template: adds the title checklist item.

Limitations

Testing

Tested in a sandbox repo with the shared files (see valkey-io/valkey-glide#7770). Dry-ran the version step against this repo's releases: release-1.2 → v1.2.0 since v1.1.0. actionlint passes. Cross-repo workflow_call and _extends can only be tested after valkey-io/valkey-glide#7770 merges.

Checklist

  • This Pull Request is related to one issue.
  • Commit message has a detailed description of what changed and why.
  • PR title follows type(scope): description with a lowercase type; it becomes the release notes entry.
  • Tests are added or updated and all checks pass. (CI config)
  • CHANGELOG.md, README.md, DEVELOPER.md, and other documentation files are updated. (CONTRIBUTING.md; CHANGELOG retirement is a follow-up)
  • Destination branch is correct - main or release
  • Create merge commit if merging release branch into main, squash otherwise.

Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>
Signed-off-by: Jeremy Parr-Pearson <jeremy.parr-pearson@improving.com>

@currantw currantw left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is excellent stuff! Just a few minor comments about how best to communicate this to developers, where information should live, etc. Really excited to see this moving forward!

Comment thread CONTRIBUTING.md Resolved
Comment thread .github/pull_request_template.md Resolved
Comment thread docs/reviewing.md Resolved
@jeremyprime
jeremyprime merged commit bea8a7e into valkey-io:main Nov 18, 2026
14 checks passed
@jeremyprime
jeremyprime deleted the auto-release-notes branch November 18, 2026 23:24
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.

3 participants