chore: add automated release workflow with semantic versioning #51
Conversation
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
Add automated release workflow supporting both @v1 and @v1.x.x usage patterns. The workflow handles semver tagging, major version tag updates, and auto-generates release notes from PRs using GitHub's built-in categorization. - Add release workflow with version validation, testing, and tagging - Configure GitHub release notes with PR label categorization - Document version pinning patterns in README (@v1, @v1.x.x, @sha) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
adityamaru
approved these changes
Nov 13, 2025
Contributor
adityamaru
left a comment
adityamaru
left a comment
There was a problem hiding this comment.
lgtm, bugbot comment worth considering?
Explicitly search for semver tags (v*.*.*) instead of using git describe to ensure predictable comparisons. This avoids ambiguity when both major version tags (v1) and semver tags (v1.1.0) point to the same commit.
taha-au
force-pushed
the
chore/automated-release-workflow
branch
from
08c756f to
8b034fb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Adds automated release workflow to support semantic versioning with both
@v1and@v1.x.xusage patterns.Changes
✅ Automated Release Workflow (
.github/workflows/release.yml)✅ Release Notes Configuration (
.github/release.yml)✅ Documentation (README.md)
@v1- Recommended, gets automatic updates@v1.x.x- Pin to specific version@<sha>- Maximum security/stabilityUsage
After merge, releases can be created via:
GitHub UI
v1.1.0)CLI
Testing
Next Steps
After merging, we can cut v1.1.0 to release the features accumulated since v1:
Note
Adds a GitHub Actions release workflow with semver tags/notes and updates README with version pinning guidance.
.github/workflows/release.ymlto validate versions, run tests/build, create semver tags, optionally update major tag, and publish GitHub Releases with generated notes..github/release.ymlto categorize changelog entries by labels and exclude specific labels/authors.README.mdwith a basic usage example and detailed version pinning options (@v1, exact@vX.Y.Z, commit@<sha>).Written by Cursor Bugbot for commit 8b034fb. This will update automatically on new commits. Configure here.