version-bump

name	version-bump
description	Version Bump
disable-model-invocation	true

Version Bump

Handle version bumps after changesets are ready. This command runs changeset version, syncs Cargo.toml, and updates the What's New translations.

Instructions

1. Run Changeset Version

First, run the changeset version command to apply pending changesets:

pnpm changeset version

This will:

• Update package versions based on changesets
• Generate/update CHANGELOG.md files
• Remove consumed changeset files

2. Run Version Sync Script

After changeset version completes, run the version bump script to sync versions and generate What's New content:

bun scripts/version-bump.ts --generate-whats-new

This will:

• Sync the apps/desktop/package.json version to apps/desktop/src-tauri/Cargo.toml
• Parse the CHANGELOG.md for the new version
• Generate What's New content for apps/desktop/src/locales/en.json

3. Curate the What's New Content

The generated content needs manual curation. The What's New dialog is for casual users who just want to know what changed for them. Review and edit apps/desktop/src/locales/en.json:

REMOVE entries that are too technical or irrelevant to casual users:

• Internal refactors (e.g. "Refactor VPK extraction pipeline")
• Developer-only changes (e.g. "Add debug logging for IPC commands")
• Dependency updates or build system changes
• Code quality improvements (e.g. "Migrate to stricter TypeScript config")
• Infrastructure or CI changes
• Changes to internal packages that don't affect the desktop UX

KEEP and REWRITE entries to be user-friendly:

• New features users can interact with
• Bug fixes users would have noticed
• Performance improvements users would feel
• UI/UX changes users would see

Rewriting guidelines:

• Use plain language, no jargon (avoid "IPC", "VPK", "pipeline", "middleware", etc.)
• Describe the benefit, not the implementation (e.g. "Mods install faster" not "Optimized extraction pipeline")
• Keep each entry to one short sentence
• If a technical change has a user-visible effect, describe the effect instead

Example transformations:

Generated (too technical)	Rewritten (user-friendly)
"Refactor mod installation state machine"	REMOVE (no user-visible change)
"Fix race condition in VPK extraction"	"Fixed mods sometimes failing to install"
"Add retry logic to GameBanana API calls"	"Improved reliability when browsing mods"
"Migrate auth to Better Auth v2"	REMOVE (no user-visible change)
"Add crosshair preview in settings"	"Added crosshair preview in settings"
"Optimize mod list rendering performance"	"Mod list loads faster"

4. Verify Version Sync

Confirm versions are in sync:

echo "Package.json:" && grep '"version"' apps/desktop/package.json | head -1
echo "Cargo.toml:" && grep '^version = ' apps/desktop/src-tauri/Cargo.toml

5. Run Linting and Formatting

Ensure code quality:

pnpm lint:fix
pnpm format:fix

6. Stage and Commit

Stage all version-related changes:

git add -A

Then use the /commit command or commit manually with:

chore(desktop): bump version to X.X.X

Dry Run Mode

To preview changes without modifying files:

bun scripts/version-bump.ts --generate-whats-new --dry-run

Manual What's New Entry

If automatic generation doesn't produce good results, manually add an entry to apps/desktop/src/locales/en.json:

{
  "whatsNew": {
    "versions": {
      "X.X.X": {
        "title": "Feature Title & Another Feature",
        "features": [
          "🔧 Description of first change",
          "✨ Description of new feature",
          "🐛 Bug fix description"
        ]
      }
    }
  }
}

Emoji Guidelines

Emoji	Usage
🔧	Bug fixes, configuration
✨	New features, UI improvements
🔒	Auth, security
🎯	Crosshairs
🔌	Plugins
🎨	Themes, styling
📁	Profiles, file management
📥	Downloads
📦	VPK, packaging
🌐	Localization, languages
🛠️	Developer tools
⚡	Performance
🛡️	Security
🐛	Bug fixes

Example Usage

User: "version bump", "bump version", or /version-bump

Response:

1. Run pnpm changeset version
2. Run bun scripts/version-bump.ts --generate-whats-new
3. Review generated What's New content
4. Verify version sync
5. Run linting and formatting
6. Stage and commit changes

Related Files

• scripts/version-bump.ts - Version sync and What's New generation script
• apps/desktop/package.json - Desktop app version source of truth
• apps/desktop/src-tauri/Cargo.toml - Rust version (must match package.json)
• apps/desktop/CHANGELOG.md - Source for What's New content
• apps/desktop/src/locales/en.json - What's New translations