Repository navigation
ci: draft release notes per release branch from PR titles - #655
Merged
Merged
Conversation
This was referenced Nov 17, 2026
yipin-chen
approved these changes
Nov 17, 2026
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>
jeremyprime
force-pushed
the
auto-release-notes
branch
from
November 18, 2026 17:04
22cb737 to
f9aeaf8
Compare
currantw
approved these changes
Nov 18, 2026
currantw
left a comment
Collaborator
There was a problem hiding this comment.
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!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.Ybranch 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
type(scope): descriptionwith a lowercase type. The newpr-title / Validate PR titlecheck enforces it, and Dependabot PRs are exempt.!→ Breaking Changes,feat→ Features,fix→ Bug Fixes,perf→ Performance.docs,ci,build,test,chore,refactorandstyleare left out, and anything else lands in Other Changes. Addskip-changelogto leave a PR out..github/release-drafter.ymlif wanted.Implementation
.github/release-drafter.yml:_extendsthe valkey-glide config..github/workflows/pr-title.ymland.github/workflows/draft-release.yml: call the valkey-glide workflows@main, assemgrep.ymlandgit-secrets-scan.ymldo.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.Limitations
pr-title / Validate PR titlea required check, set the squash commit default to the PR title, and add the workflows torelease-1.2.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.0sincev1.1.0. actionlint passes. Cross-repoworkflow_calland_extendscan only be tested after valkey-io/valkey-glide#7770 merges.Checklist
type(scope): descriptionwith a lowercase type; it becomes the release notes entry.CHANGELOG.md,README.md,DEVELOPER.md, and other documentation files are updated. (CONTRIBUTING.md; CHANGELOG retirement is a follow-up)mainor releasemain, squash otherwise.