Back to Lobehub

Version Release Workflow

.agents/skills/version-release/SKILL.md

2.1.584.2 KB
Original Source

Version Release Workflow

This skill is a router. The detailed steps live in references/.

Scope Boundary (Important)

This skill is only for:

  1. Release branch / PR workflow
  2. CI trigger constraints (auto-tag-release.yml)
  3. GitHub Release note writing

This skill is not for writing docs/changelog/*.mdx.
If the user asks for website changelog pages, load ../docs-changelog/SKILL.md.

Mandatory Companion Skill

For every /version-release execution, you MUST load and apply:

  • ../microcopy/SKILL.md

Overview

The primary development branch is canary. All day-to-day development happens on canary. When releasing, canary is merged into main. After merge, auto-tag-release.yml automatically handles tagging, version bumping, creating a GitHub Release, and syncing back to the canary branch.

Only two release types are used in practice (major releases are extremely rare and can be ignored):

TypeUse CaseFrequencySource BranchPR Title FormatVersionReference
MinorFeature iteration release~Every 4 weekscanary๐Ÿš€ release: v{x.y.0}Manually setreferences/minor-release.md
PatchWeekly release / hotfix / model / DB migration~Weekly or as neededcanary or mainCustom (e.g. ๐Ÿš€ release: 20260222)Auto patch +1references/patch-release-scenarios.md

For writing the release-note body (any release type), see references/release-notes-style.md.

Auto-Release Trigger Rules (auto-tag-release.yml)

After a PR is merged into main, CI determines whether to release based on the following priority:

1. Minor Release (Exact Version)

PR title matches ๐Ÿš€ release: v{x.y.z} -> uses the version number from the title.

2. Patch Release (Auto patch +1)

Triggered by the following priority:

  • Branch name match: hotfix/* or release/* -> triggers directly (skips title detection)
  • Title prefix match: PRs with the following title prefixes will trigger:
    • style / ๐Ÿ’„ style
    • feat / โœจ feat
    • fix / ๐Ÿ› fix
    • refactor / โ™ป๏ธ refactor
    • hotfix / ๐Ÿ› hotfix / ๐Ÿฉน hotfix
    • build / ๐Ÿ‘ท build

3. No Trigger

PRs that don't match any conditions above (e.g. docs, chore, ci, test) will not trigger a release when merged into main.

Post-Release Automated Actions

  1. Bump package.json โ€” commits ๐Ÿ”– chore(release): release version v{x.y.z} [skip ci]
  2. Create annotated tag โ€” v{x.y.z}
  3. Create GitHub Release
  4. Dispatch sync-main-to-canary โ€” syncs main back to canary

Agent Action Guide

When the user requests a release:

Precheck (applies to all release types)

Before creating the release branch, verify the source branch:

  • Weekly Release (release/weekly-*): must branch from canary
  • All other release/hotfix branches: must branch from main; run git merge-base --is-ancestor main <branch> && echo OK
  • If the branch is based on the wrong source, recreate from the correct base

Routing

Pick the right reference and follow it end-to-end:

  • Minor release โ†’ references/minor-release.md
  • Patch release (weekly / hotfix / model launch / DB migration) โ†’ references/patch-release-scenarios.md
  • Writing the PR body / release notes (any release type) โ†’ references/release-notes-style.md

Hard Rules (apply to every release type)

  • Do NOT manually modify package.json version โ€” CI handles it.
  • Do NOT manually create tags โ€” CI handles them.
  • Minor PR title format is strict (๐Ÿš€ release: v{x.y.z}).
  • Patch PRs do not need an explicit version number.
  • Keep release facts accurate; do not invent metrics or availability statements. Release-note inputs (compare base, PR refs, contributor list) must be derived from git per references/release-notes-style.md ยง Computing Inputs โ€” never from memory or descriptions.