prepare-release
Prepare a new release by collecting commits, generating bilingual release notes, updating version files, and creating a release branch with PR. Use when asked to prepare/create a release, bump version, or run `/prepare-release`.
CherryHQ · AI review on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add CherryHQ/cherry-studio --skill prepare-releaseAbout this skill
name: prepare-release
description: Prepare a new release by collecting commits, generating bilingual release notes, updating version files, and creating a release branch with PR. Use when asked to prepare/create a release, bump version, or run /prepare-release.
Prepare Release
Automate the Cherry Studio release workflow: collect changes → generate bilingual release notes → update files → create release branch + PR → trigger CI/CD.
Arguments
Parse the version intent from the user's message. Accept any of these forms:
- Bump type keyword:
patch,minor,major - Exact version:
x.y.zorx.y.z-pre.N(e.g.1.8.0,1.8.0-beta.1,1.8.0-rc.1) - Natural language: "prepare a beta release", "bump to 1.8.0-rc.2", etc.
Defaults to patch if no version is specified. Always echo the resolved target version back to the user before proceeding with any file edits.
--dry-run: Preview only, do not create branch or PR.
Workflow
Step 1: Determine Version
- Get the latest tag:
git describe --tags --abbrev=0 - Read current version from
package.json. - Compute the new version based on the argument:
patch/minor/major: bump from the current tag version.x.y.zorx.y.z-pre.N: use as-is after validating it is valid semver.
Step 2: Collect Commits
- List all commits since the last tag:
git log <last-tag>..HEAD --format="%H %s" --no-merges - For each commit, get the full body:
git log <hash> -1 --format="%B" - Extract the content inside
```release-notecode blocks from each commit body. - Extract the conventional commit type from the title (
feat,fix,refactor,perf,docs, etc.). - Skip these commits:
- Titles starting with
🤖 Daily Auto I18N - Titles starting with
Merge - Titles starting with
chore(deps) - Titles starting with
chore: release - Commits where the release-note block says
NONE
- Titles starting with
Step 3: Generate Bilingual Release Notes
Using the collected commit information, generate release notes in both English and Chinese.
Format (must match exactly):
<!--LANG:en-->
Cherry Studio {version} - {Brief English Title}
✨ New Features
- [Component] Description
🐛 Bug Fixes
- [Component] Description
💄 Improvements
- [Component] Description
⚡ Performance
- [Component] Description
<!--LANG:zh-CN-->
Cherry Studio {version} - {简短中文标题}
✨ 新功能
- [组件] 描述
🐛 问题修复
- [组件] 描述
💄 改进
- [组件] 描述
⚡ 性能优化
- [组件] 描述
<!--LANG:END-->
Rules:
- Only include categories that have entries (omit empty categories).
- Each commit appears as exactly ONE line item in the appropriate category.
- Use the
release-notefield if present; otherwise summarize from the commit title. - Component tags should be short:
[Chat],[Models],[Agent],[MCP],[Settings],[Data],[Build], etc. - Chinese translations should be natural, not machine-literal.
- Do NOT include commit hashes or PR numbers.
- Read the existing release notes in
electron-builder.ymlas a style reference before writing.
IMPORTANT: User-Focused Content Only
Release notes are for end users, not developers. Exclude anything users don't care about:
- EXCLUDE internal refactoring, code cleanup, or architecture changes
- EXCLUDE CI/CD, build tooling, or test infrastructure changes
- EXCLUDE dependency updates (unless they add user-visible features)
- EXCLUDE documentation updates
- EXCLUDE developer experience improvements
- EXCLUDE technical debt fixes with no user-visible impact
- EXCLUDE overly technical descriptions (e.g., "fix race condition in Redux middleware")
INCLUDE only changes that users will notice:
- New features they can use
- Bug fixes that affected their workflow
- UI/UX improvements they can see
- Performance improvements they can feel
- Security fixes (simplified, without implementation details)
Keep descriptions simple and non-technical:
- ❌ "Fix streaming race condition causing partial tool response status in Redux state"
- ✅ "Fix tool status not stopping when aborting"
- ❌ "Auto-convert reasoning_effort to reasoningEffort for OpenAI-compatible providers"
- ✅ "Fix deep thinking mode not working with some providers"
Step 4: Update Files
package.json: Update the"version"field to the new version.electron-builder.yml: Replace the content underreleaseInfo.releaseNotes: |with the generated notes. Preserve the 4-space YAML indentation for the block scalar content.resources/cherry-studio/release-history.json: For a stablex.y.zrelease, add the version and its exact generated bilingual notes at the start of the array. Replace an existing entry for the same version instead of creating a duplicate. Leave this file unchanged for prereleases.- Built-in knowledge: Run
pnpm build:builtin-knowledgeafter updating the version. This refreshesresources/builtin-agents/cherry-assistant/product-manifest.jsonwith the new package version. Never edit the generated manifest by hand.
Step 5: Present for Review
Show the user:
- The new version number.
- The full generated release notes.
- A summary of which files were modified.
If --dry-run was specified, stop here.
Otherwise, ask the user to confirm before proceeding to Step 6.
Step 6: Create Branch and PR
- Create and push the release branch:
git checkout -b release/v{version} git add package.json electron-builder.yml resources/cherry-studio/release-history.json resources/builtin-agents/cherry-assistant/product-manifest.json git commit -m "chore: release v{version}" git push -u origin release/v{version} - Create the PR using the
gh-create-prskill. If the skill tool is unavailable, read.agents/skills/gh-create-pr/SKILL.mdand follow it manually. In CI (non-interactive) mode, skip interactive confirmation steps and create the PR directly after filling the