versioning-policy

Semver versioning rules for Squad SDK and CLI — prevents prerelease version incidents

1,828 stars

Best use case

versioning-policy is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Semver versioning rules for Squad SDK and CLI — prevents prerelease version incidents

Teams using versioning-policy should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/versioning-policy/SKILL.md --create-dirs "https://raw.githubusercontent.com/bradygaster/squad/main/.squad/skills/versioning-policy/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/versioning-policy/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How versioning-policy Compares

Feature / Agentversioning-policyStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Semver versioning rules for Squad SDK and CLI — prevents prerelease version incidents

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

## Context

Squad is a monorepo with two publishable npm packages (`@bradygaster/squad-sdk` and `@bradygaster/squad-cli`) managed via npm workspaces. Version mismatches and prerelease leaks have caused production incidents — most notably PR #640, where a `-build.N` prerelease version silently broke workspace dependency resolution.

This skill codifies the versioning rules every agent must follow.

## 1. Version Format

All packages use **strict semver**: `MAJOR.MINOR.PATCH`

- ✅ `0.9.1`, `1.0.0`, `0.10.0`
- ❌ `0.9.1-build.4`, `0.9.1-preview.1`, `0.8.6.1-preview`

No prerelease suffixes on `dev` or `main` branches — ever.

## 2. Prerelease Versions Are Ephemeral

The `scripts/bump-build.mjs` script creates `-build.N` versions (e.g., `0.9.1-build.4`) for **local development testing only**.

Rules:
- `-build.N` versions are created automatically during local `npm run build`
- They are **never committed** to `dev` or `main`
- The script skips itself in CI (`CI=true` or `SKIP_BUILD_BUMP=1`)
- If you see a `-build.N` version in a PR diff, it is a bug — reject the PR

## 3. SDK and CLI Version Sync

Both `@bradygaster/squad-sdk` and `@bradygaster/squad-cli` **MUST have the same version** at all times. The root `package.json` version must also match.

`bump-build.mjs` enforces this by updating all three `package.json` files in lockstep (root + `packages/squad-sdk` + `packages/squad-cli`).

If versions diverge, workspace resolution silently breaks (see §4).

## 4. npm Workspace Semver Footgun

The CLI depends on the SDK via a workspace dependency with a semver range:

```json
"@bradygaster/squad-sdk": ">=0.9.0"
```

**Critical:** Per the semver specification, `>=0.9.0` does **NOT** match `0.9.1-build.4`.

Semver prerelease versions (anything with a `-` suffix) are only matched by ranges that explicitly reference the same `MAJOR.MINOR.PATCH` base with a prerelease comparator. A bare `>=0.9.0` range skips all prerelease versions.

**What happens:** When the local SDK has version `0.9.1-build.4`, npm's workspace resolution fails to match the `>=0.9.0` range. npm then **silently installs a stale published version** from the npm registry instead of using the local workspace link. The build succeeds but runs against old SDK code.

This is the root cause of the **PR #640 incident**, where workspace packages appeared linked but were actually running against stale registry versions.

## 5. Who Bumps Versions

**Surgeon (Release Manager) owns all version bumps.**

| Agent | May modify `version` in package.json? |
|-------|---------------------------------------|
| Surgeon | ✅ Yes — sole owner of version bumps |
| Any other agent | ❌ No — unless explicitly fixing a prerelease leak |

If you discover a prerelease version committed to `dev` or `main`, you may fix it (revert to the clean release version) without Surgeon's approval. This is a safety escape hatch, not a license to manage versions.

## 6. Version Bump Lifecycle

```
┌─────────────────────────────────────────────────────────┐
│  Development phase                                      │
│  Versions stay at current release: 0.9.1                │
│  bump-build.mjs creates -build.N locally (not committed)│
├─────────────────────────────────────────────────────────┤
│  Pre-release testing                                    │
│  bump-build.mjs → 0.9.1-build.1, -build.2, ...         │
│  Local only. Never committed. Never pushed.             │
├─────────────────────────────────────────────────────────┤
│  Release                                                │
│  Surgeon bumps to next version (e.g., 0.9.2 or 0.10.0) │
│  Tags, publishes to npm registry                        │
├─────────────────────────────────────────────────────────┤
│  Post-release                                           │
│  Versions stay at the new release version (e.g., 0.9.2) │
│  Development continues on clean version                 │
└─────────────────────────────────────────────────────────┘
```

## 7. CI Enforcement

The **`prerelease-version-guard`** CI gate blocks any PR to `dev` or `main` that contains prerelease version strings in `package.json` files.

- The gate scans all three `package.json` files for `-` in the version field
- PRs with prerelease versions **cannot merge** until the version is cleaned
- The `skip-version-check` label bypasses the gate — use **only** for the bump-build script's own PR (if applicable), and only with Surgeon's approval

## 8. Incident Reference — PR #640

**PR #640** is the cautionary tale for this entire policy.

**What happened:** Prerelease versions (`0.9.1-build.4`) were committed to a branch. The workspace dependency `>=0.9.0` failed to match the prerelease version per semver spec. npm silently installed a stale published SDK from the registry instead of linking the local workspace copy. Four PRs (#637–#640) attempted iterative patches before the root cause was identified.

**Root cause:** No versioning policy existed. Agents didn't know that prerelease versions break workspace resolution, or that only Surgeon should modify versions.

**Resolution:** This skill, the `prerelease-version-guard` CI gate, and the team decision to centralize version ownership under Surgeon.

## Quick Reference

| Rule | Summary |
|------|---------|
| Format | `MAJOR.MINOR.PATCH` — no prerelease on dev/main |
| Prerelease | `-build.N` is local-only, never committed |
| Sync | SDK + CLI + root must have identical versions |
| Ownership | Surgeon bumps versions; others don't touch them |
| CI gate | `prerelease-version-guard` blocks prerelease PRs |
| Escape hatch | Any agent may revert a prerelease leak to clean version |
| Footgun | `>=0.9.0` does NOT match `0.9.1-build.4` per semver |

Related Skills

My Skill

1828
from bradygaster/squad

No description provided.

rework-rate

1828
from bradygaster/squad

Measure and interpret PR rework rate — the emerging 5th DORA metric

project-conventions

1828
from bradygaster/squad

Core conventions and patterns for this codebase

tiered-memory

1828
from bradygaster/squad

Three-tier agent memory model (hot/cold/wiki) for 20-55% context reduction per spawn

test-discipline

1828
from bradygaster/squad

Update tests when changing APIs — no exceptions

Skill: Retro Enforcement

1828
from bradygaster/squad

## Purpose

reflect

1828
from bradygaster/squad

Learning capture system that extracts HIGH/MED/LOW confidence patterns from conversations to prevent repeating mistakes. Use after user corrections ("no", "wrong"), praise ("perfect", "exactly"), or when discovering edge cases. Complements .squad/agents/{agent}/history.md and .squad/decisions.md.

notification-routing

1828
from bradygaster/squad

Route agent notifications to specific channels by type — prevent alert fatigue from single-channel flooding

iterative-retrieval

1828
from bradygaster/squad

Max-3-cycle protocol for agent sub-tasks with WHY context and coordinator validation. Use when spawning sub-agents to complete scoped work.

error-recovery

1828
from bradygaster/squad

Standard recovery patterns for all squad agents. When something fails, adapt — don't just report the failure.

docs-standards

1828
from bradygaster/squad

Microsoft Style Guide + Squad-specific documentation patterns

{skill-name}

1828
from bradygaster/squad

{what this skill teaches agents}