version-release

Automates GitHub release branch, PR, and release-note workflows for minor and patch versions.

Updated Jan 27, 2026
One-click install
npx skills add https://github.com/SmallAi-API/smaihub --skill version-release-smallai-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: version-release
Source: https://github.com/SmallAi-API/smaihub/tree/main/.agents/skills/version-release
Command: npx skills add https://github.com/SmallAi-API/smaihub --skill version-release-smallai-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Coordinating version releases across canary and main branches involves strict PR title formats, CI trigger rules, and release-note conventions that are easy to get wrong. This Skill encodes the full release workflow so branches, PRs, tags, and GitHub Release notes follow the correct process every time. ## Core Features & Use Cases - Minor Release Workflow: Creates a release/v{x.y.z} branch from canary, computes the next minor version from package.json, and opens a PR whose title CI parses to tag and publish the release. - Patch Release Scenarios: Covers weekly releases, hotfixes, new model launches, and DB schema migrations, each with the correct source branch, branch naming, and PR title prefix. - Release Notes Standard: Provides a long-form GitHub Release changelog template with git-derived metrics, verified PR references, contributor credits, and short-form variants for hotfixes and migrations. - Use Case: When asked to ship the weekly release, the Skill creates release/weekly-{YYYYMMDD} from canary, computes the compare range from the latest semver tag on main, and writes a verified changelog as the PR body. ## Quick Start Ask the agent to prepare a minor or weekly patch release from the canary branch and generate the GitHub Release notes for it.

Frequently Asked Questions about version-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a minor release PR on GitHub?

Create a release/v{x.y.z} branch from canary, then open a PR to main with the exact title format "🚀 release: v{x.y.z}". CI parses the version from the title to bump package.json, tag the release, and publish the GitHub Release automatically.

How to write GitHub Release notes from git history?

Compute the compare base with git describe --tags on main, extract PR numbers from commit subjects in that range, and count commits and contributors with git log. Every PR reference and metric in the notes must come from these git commands, never from memory.

What triggers an automatic patch release after merging to main?

A merge to main triggers auto patch +1 when the branch matches hotfix/* or release/*, or when the PR title starts with prefixes like feat, fix, style, refactor, hotfix, or build. Titles like docs, chore, ci, or test do not trigger a release.

Can I manually bump the version in package.json for a release?

No. The CI workflow handles the package.json version bump, tag creation, and GitHub Release after the release PR merges. Manually editing the version or creating tags breaks the automated release pipeline.

How do I release a database schema migration?

Create a release/db-migration-{name} branch from main, cherry-pick the migration commits, and open a PR with a build-prefix title. The body must include a migration overview, operator impact, rollback notes, and the actual PR author as owner.

When should I not use this release workflow?

Do not use it for writing website changelog pages under docs/changelog, which follow a different format. It also does not cover major releases, which are rare and handled outside the standard minor and patch flows.