
Release Coordination
FreeStreamline your Paperclip release process with ease.
Free · Opens the source repo
What Release Coordination does
The Release Coordination Skill is designed to automate and manage the entire release workflow for Paperclip, ensuring a smooth and efficient process from verification to announcement. This skill is particularly useful for maintainers who need to coordinate multiple tasks associated with a release, such as drafting changelogs, performing smoke tests, and creating GitHub releases. It integrates with existing tools and scripts to provide a comprehensive solution for managing releases.
When using this skill, you can expect to handle stable changelog generation, canary verification, and Docker smoke testing seamlessly. By following a structured workflow, you can ensure that each release is properly vetted and documented. The skill also facilitates the promotion of canary versions to stable releases, which is crucial for maintaining the integrity of your software. Additionally, it helps in managing follow-up tasks related to announcements and website updates, ensuring that all aspects of the release are covered.
This skill is ideal for engineering teams and project leads who are responsible for shipping releases and want to minimize the risk of errors during the process. It requires a clean working environment and certain preconditions to be met before proceeding, which helps maintain the quality and reliability of the releases. By automating repetitive tasks and providing clear guidelines, the Release Coordination Skill allows teams to focus on development rather than the logistics of release management.
Overall, this skill is a valuable addition for teams using Paperclip, as it streamlines the release process and ensures that all necessary steps are completed effectively and efficiently.
When to use it
Use this skill when you need to execute a full Paperclip release, especially when leadership requests a release.
When not to use it
This skill is not suitable for projects that do not use Paperclip or for simple versioning discussions that do not require a full release process.
What you can build with it
Shipping a Stable Release
When leadership requests to 'ship a release', use this skill to manage the entire release process from verification to announcement.
Promoting a Canary to Stable
If you need to promote a canary version to stable, this skill helps ensure that all necessary checks and validations are performed.
Drafting Changelogs
Use this skill to automate the drafting of stable changelogs, ensuring they are accurate and up-to-date before publication.
How to install Release Coordination
View source1. Install with the skills CLI
npx skills add paperclipai/paperclip/release --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by paperclipaiRelease Coordination Skill
Run the full Paperclip maintainer release workflow, not just an npm publish.
This skill coordinates:
- stable changelog drafting via
release-changelog - canary verification and publish status from
master - Docker smoke testing via
scripts/docker-onboard-smoke.sh - manual stable promotion from a chosen source ref
- GitHub Release creation
- website / announcement follow-up tasks
- release-content Cases dogfood: a top-level
releasecase with childblog_postandtweet_stormcases, all linked to the release issue/run
Trigger
Use this skill when leadership asks for:
- "do a release"
- "ship the release"
- "promote this canary to stable"
- "cut the stable release"
Preconditions
Before proceeding, verify all of the following:
.agents/skills/release-changelog/SKILL.mdexists and is usable.- The repo working tree is clean, including untracked files.
- There is at least one canary or candidate commit since the last stable tag.
- The candidate SHA has passed the verification gate or is about to.
- If manifests changed, the CI-owned
pnpm-lock.yamlrefresh is already merged onmaster. - npm publish rights are available through GitHub trusted publishing, or through local npm auth for emergency/manual use.
- If running through Paperclip, you have issue context for status updates and follow-up task creation.
If any precondition fails, stop and report the blocker.
Inputs
Collect these inputs up front:
- whether the target is a canary check or a stable promotion
- the candidate
source_reffor stable - whether the stable run is dry-run or live
- release issue / company context for website and announcement follow-up
Step 0 — Release Model
Paperclip now uses a commit-driven release model:
- every push to
masterpublishes a canary automatically - canaries use
YYYY.MDD.P-canary.N - stable releases use
YYYY.MDD.P - the middle slot is
MDD, whereMis the UTC month andDDis the zero-padded UTC day - the stable patch slot increments when more than one stable ships on the same UTC date
- stable releases are manually promoted from a chosen tested commit or canary source commit
- only stable releases get
releases/vYYYY.MDD.P.md, git tagvYYYY.MDD.P, and a GitHub Release
Critical consequences:
- do not use release branches as the default path
- do not derive major/minor/patch bumps
- do not create canary changelog files
- do not create canary GitHub Releases
Step 1 — Choose the Candidate
For canary validation:
- inspect the latest successful canary run on
master - record the canary version and source SHA
For stable promotion:
- choose the tested source ref
- confirm it is the exact SHA you want to promote
- resolve the target stable version with
./scripts/release.sh stable --date YYYY-MM-DD --print-version
Useful commands:
git tag --list 'v*' --sort=-version:refname | head -1
git log --oneline --no-merges
npm view paperclipai@canary version
Step 2 — Draft the Stable Changelog
Stable changelog files live at:
releases/vYYYY.MDD.P.md
Invoke release-changelog and generate or update the stable notes only.
Rules:
- review the draft with a human before publish
- preserve manual edits if the file already exists
- keep the filename stable-only
- do not create a canary changelog file
Step 3 — Verify the Candidate SHA
Run the standard gate:
pnpm -r typecheck
pnpm test:run
pnpm build
If the GitHub release workflow will run the publish, it can rerun this gate. Still report local status if you checked it.
For PRs that touch release logic, the repo also runs a canary release dry-run in CI. That is a release-specific guard, not a substitute for the standard gate.
Step 4 — Validate the Canary
The normal canary path is automatic from master via:
.github/workflows/release.yml
Confirm:
- verification passed
- npm canary publish succeeded
- git tag
canary/vYYYY.MDD.P-canary.Nexists
Useful checks:
npm view paperclipai@canary version
git tag --list 'canary/v*' --sort=-version:refname | head -5
Step 5 — Smoke Test the Canary
Run:
PAPERCLIPAI_VERSION=canary ./scripts/docker-onboard-smoke.sh
Useful isolated variant:
HOST_PORT=3232 DATA_DIR=./data/release-smoke-canary PAPERCLIPAI_VERSION=canary ./scripts/docker-onboard-smoke.sh
Confirm:
- install succeeds
- onboarding completes without crashes
- the server boots
- the UI loads
- basic company creation and dashboard load work
If smoke testing fails:
- stop the stable release
- fix the issue on
master - wait for the next automatic canary
- rerun smoke testing
Step 6 — Preview or Publish Stable
The normal stable path is manual workflow_dispatch on:
.github/workflows/release.yml
Inputs:
source_refstable_datedry_run
Before live stable:
- resolve the target stable version with
./scripts/release.sh stable --date YYYY-MM-DD --print-version - ensure
releases/vYYYY.MDD.P.mdexists on the source ref - run the stable workflow in dry-run mode first when practical
- then run the real stable publish
The stable workflow:
- re-verifies the exact source ref
- computes the next stable patch slot for the chosen UTC date
- publishes
YYYY.MDD.Punder dist-taglatest - creates git tag
vYYYY.MDD.P - creates or updates the GitHub Release from
releases/vYYYY.MDD.P.md
Local emergency/manual commands:
./scripts/release.sh stable --dry-run
./scripts/release.sh stable
git push public-gh refs/tags/vYYYY.MDD.P
./scripts/create-github-release.sh YYYY.MDD.P
Step 7 — Finish the Other Surfaces
Create or verify follow-up work for:
- website changelog publishing
- launch post / social announcement
- release summary in Paperclip issue context
These should reference the stable release, not the canary.
Step 8 — Emit Release-Content Cases
When Cases are enabled, every stable release-content run must materialize a
deterministic case tree. This is part of the release dogfood path, not an
optional artifact. If the API returns 403 Cases are disabled, stop and report
that the operator must enable experimental.enableCases.
Use the current release issue's PAPERCLIP_COMPANY_ID, PAPERCLIP_API_URL,
PAPERCLIP_API_KEY, and PAPERCLIP_RUN_ID. Include X-Paperclip-Run-Id on
all writes so the case activity feed can attribute the run back to the issue.
Create or upsert the parent release case first:
POST /api/companies/:companyId/cases
{
"caseType": "release",
"key": "paperclip-release:vYYYY.MDD.P",
"title": "Paperclip vYYYY.MDD.P release",
"summary": "Stable release content package for Paperclip vYYYY.MDD.P.",
"status": "in_progress",
"fields": {
"schema_version": 1,
"version": "vYYYY.MDD.P",
"release_date": "YYYY-MM-DD",
"source_ref": "git-sha-or-ref",
"stable": true,
"channels": ["changelog", "blog_post", "tweet_storm"],
"artifacts": {
"changelog_path": "releases/vYYYY.MDD.P.md",
"github_release_url": null
},
"verification": {
"typecheck": "unknown",
"tests": "unknown",
"build": "unknown",
"smoke": "unknown"
},
"notes": null
}
}
The fields schema intentionally uses all generic JSON value types: strings,
numbers, booleans, arrays, objects, and nulls. Send the complete fields object on
each upsert because case fields replace as a whole object.
Write the parent body document immediately after the upsert:
PUT /api/cases/:releaseCaseId/documents/body
{
"title": "Paperclip vYYYY.MDD.P release body",
"format": "markdown",
"body": "# Paperclip vYYYY.MDD.P\n\nRelease summary and links...",
"changeSummary": "Initial release case body"
}
Then create or upsert these child cases with parentCaseId set to the release
case id:
blog_post, keypaperclip-release:vYYYY.MDD.P:blog-post, statusin_progress, body document keybodytweet_storm, keypaperclip-release:vYYYY.MDD.P:tweet-storm, statusin_progress, body document keybody
Use deterministic keys exactly so rerunning the release-content flow upserts the same three cases instead of duplicating them. After the child body documents are written, list the resulting case identifiers and links in the release issue and in the parent acceptance issue when one exists.
Failure Handling
If the canary is bad:
- publish another canary, do not ship stable
If stable npm publish succeeds but tag push or GitHub release creation fails:
- fix the git/GitHub issue immediately from the same release result
- do not republish the same version
If latest is bad after stable publish:
./scripts/rollback-latest.sh <last-good-version>
Then fix forward with a new stable release.
Output
When the skill completes, provide:
- candidate SHA and tested canary version, if relevant
- stable version, if promoted
- verification status
- npm status
- smoke-test status
- git tag / GitHub Release status
- website / announcement follow-up status
- release-content case tree links: parent
releasecase plusblog_postandtweet_stormchildren - rollback recommendation if anything is still partially complete
Frequently asked questions about Release Coordination
Similar skills
Turborepo
Optimized build system for JavaScript/TypeScript monorepos.
Azure Pipelines Validation
Streamline your Azure DevOps pipeline changes locally.
Azure Developer CLI
Streamline your Azure project workflows with best practices.
Azure Container Registry CLI
Manage Azure Container Registry resources with ease.
Aspire
Build and orchestrate polyglot distributed applications seamlessly.
Vercel CLI
Manage and deploy Vercel projects from the command line.
