agentleFS
Sign inStart free
OpenSourcxOpenSourcx/papercliped/.agents/skills/release/SKILL.md

release

Skill12 starsChanged 39 days agoMITView on GitHub

Version, describe and ship every push. Use before EVERY commit you push to main (code, docs or config) — it decides Major.Minor.Patch, bumps every version string with scripts/version.mjs, writes the changelog entry and the commit description that become the release notes, and checks CI publishes it. Also use when setting up the same release flow in a new repository.

196 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-agent-adapter, changelog-style and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    create-agent-adapter

    Technical guide for creating a new Paperclip agent adapter. Use when building a new adapter package, adding support for a new AI coding tool (e.g. a new CLI agent, API-based agent, or custom process), or when modifying the adapter system. Covers the required interfaces, module structure, registration points, and conventions derived from the existing claude-local and codex-local adapters.

    Also in 5 projects that use this

  • GrinvSkill

    changelog-style

    Turn a commit range into CHANGELOG.md entries following common-changelog style. Use when finishing a PR or cutting a release, to write/fix the [Unreleased] section's entries — moving [Unreleased] under a new dated version heading is a separate, automated step (see the release skill / scripts/sync-version.ts), not this skill's job.

    Also in 4 projects that use this

  • GrinvSkill

    docs-consistency-check

    Check README/manifest.json/server.json/CHANGELOG.md/AGENTS.md and docs/*.md for drift against the actual registered tools and source. Use after adding, renaming, or removing a tool, or as part of a live-audit pass.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    component-release

    Prepares a verifiable Agent Landing Zone UI release. Use for release branches, VERSION, changelog entries, tags, release notes, and compatibility evidence; never publish without explicit human approval.

    Also in 4 projects that use this

  • Microsoft AzureSkill

    documentation-consistency

    Keeps AI Landing Zone contributor, user, and operator documentation aligned with shipped Bicep behavior. Use for parameters, defaults, outputs, topology, deployment flow, operations, or releases.

    Also in 8 projects that use this

  • rivet-devSkill

    launch-graphics

    Generate agentOS marketing/launch graphics (launch & social heroes, code-snippet cards) from the committed generators in docs-internal/graphics. Use when asked to make, update, or render an agentOS launch image, social image, "agentOS Apps" graphic, or technical code-snippet image.

    Also in 3 projects that use this

  • +3 more from Grinv

The file

We split this skill into the rules it gives an agent

4 rules. 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 186 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Look at what the push changes for someone using the project (AI-app users, self-hosters, plugin installers, API callers).

    line 12
  2. Very specific:

    Add the user-facing story under ## Unreleased at the top of CHANGELOG.md, one bullet per change, starting with a bold phrase:

    line 24
  3. Distinctive:

    Write for users: what changed and what they need to do, not which files moved.

    line 33
  4. Very specific:

    Run the checks CI runs (here: npm run build && npm test, npm --prefix plugin test, npm --prefix web test, node scripts/check-packages.mjs).

    line 61

“Common” is measured: kept by at least 6 in 10 of the 186 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Release: every push is a version

Every push to main ships as a release. CI (.github/workflows/release.yml) reads the version in package.json; if v<version> isn't tagged yet it tests, publishes the npm packages, tags that exact commit and creates the GitHub release. So every push carries a new version, and the commit description is what people read.

1. Pick the bump (Major.Minor.Patch)

Look at what the push changes for someone using the project (AI-app users, self-hosters, plugin installers, API callers). Take the highest that applies:

BumpWhenExamples
Major X.0.0Someone must change something or something they rely on stops workingremoving or renaming a tool, scope, endpoint, env var, CLI flag or config key; a migration that can't be rolled back; changing what an access level allows in a way that removes access; dropping a Node version
Minor x.Y.0New capability, nothing breaksa new tool, endpoint, page, plugin action, option or docs section; an old name kept working as an alias
Patch x.y.ZFixes and everything elsebug and security fixes, copy and docs edits, styling, refactors, tests, CI, dependency bumps

Rules: a security fix is Patch unless it forces users to act (then Major). Unsure between two → take the higher. Never reuse or go back on a version; npm refuses it and the tag would point at the wrong commit.

2. Write it down first

Add the user-facing story under ## Unreleased at the top of CHANGELOG.md, one bullet per change, starting with a bold phrase:

## Unreleased

- **Docs search finds headings.** Searching "anonymous" now jumps to the Anonymous mode section.
- **Fixed:** the plugin's level dropdown showed Read only after switching to Full control.

Write for users: what changed and what they need to do, not which files moved.

3. Bump every version string

node scripts/version.mjs <major|minor|patch> "<short release title>"
node scripts/version.mjs check

The script reads .release.json, updates every listed file (here: package.json, plugin/package.json, .claude-plugin/plugin.json, plugin/src/manifest.ts, both lockfiles), turns ## Unreleased into ## vX.Y.Z — <title> with a fresh empty ## Unreleased above it, and records the date for the website changelog. It refuses an empty ## Unreleased.

4. Commit: the description is the release note

vX.Y.Z: <what this release does, in plain words>

<Why, in one or two sentences.>

- <user-facing change>
- <user-facing change>

<Anything users must do: "Reconnect Claude", "Run the migration", or "Nothing to do".>

Then the repository's own commit trailers. One release per push: if you have several commits, bump once in the last one and describe them all there.

5. Before pushing

Run the checks CI runs (here: npm run build && npm test, npm --prefix plugin test, npm --prefix web test, node scripts/check-packages.mjs). If CI fails before anything was published, fix it and push again with the same version.

6. After pushing

Watch the Release workflow for that commit. Success = both packages on npm at the new version, tag vX.Y.Z on the commit, GitHub release with the notes. If it fails before "Publish", fix and push again (same version). If one package published and the other didn't, re-run the workflow: published versions are skipped and the tag is made last.

Adopting this in another repository

  1. Copy scripts/version.mjs and write a .release.json listing that repo's version files (kind: "json" for a top-level version, or kind: "regex" with a pattern whose first group is the version), lockfiles, changelog and optional dates file.
  2. Copy .github/workflows/release.yml and change the build, test and publish steps to that repo's.
  3. On npmjs.com, add a trusted publisher for each package: the GitHub owner, repository and release.yml.
  4. Copy this skill to .claude/skills/release/SKILL.md and .agents/skills/release/SKILL.md, and point to it from CLAUDE.md and AGENTS.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free