agentleFS
st0012st0012/cctop/.agents/skills/release/SKILL.md

release

Skill151 starsChanged 3 months agoMITView on GitHub

Use when cutting or preparing a cctop release - "cut a release", "release vX.Y.Z", "prepare a release", "bump the version and tag", "ship a new version". Drives proportionate release checks, version bump, CI, tag push, release monitoring, and verification. An explicit release request authorizes the complete release unless the developer asks to stop before publication.

  • Commits and pushes

193 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

  • 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

  • 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

    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

  • parcadeiSkill

    agent-context-isolation

    Agent Context Isolation

    Also in 3 projects that use this

  • +3 more from Grinv

The file

Show its rules and text

We split this skill into the rules it gives an agent

16 rules. 0 are common, 5 are distinctive, and 11 are very specific to this project.

  • 0

    Common

    Most of the 183 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 11

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Before proposing or adding any release check, state its reason in plain language: name the concrete failure or release risk it covers and …

    line 14
  2. Distinctive:

    Never merge feature PRs; the developer merges them.

    line 17
  3. Distinctive:

    If the developer explicitly requested the release and the version/scope are clear, continue.

    line 25
  4. Very specific:

    Always use scripts/bump-version.sh <version>.

    line 29
  5. Very specific:

    Run make all (lint + contract + build + test) before committing.

    line 30
  6. Very specific:

    Commit Bump version to <version> and land it per step 1.

    line 31
  7. Distinctive:

    If a PR was used: monitor CI to green, then stop and let the developer merge.

    line 32
  8. Very specific:

    Wait for master CI on the bump commit: gh run list --branch master --limit 5, then gh run watch <id>.

    line 36
  9. Very specific:

    Do not name shell variables status.

    line 47
  10. Distinctive:

    If any job fails, stop immediately and report the exact failure with logs.

    line 48
  11. Very specific:

    Search Sparkle.framework/Versions/B/Autoupdate for executable components.

    line 54
  12. Very specific:

    Use ./scripts/sign-and-notarize.sh --dry-run dist/cctop.app to inspect signing order.

    line 55
  13. Very specific:

    Use --sign-only only for local signing diagnosis.

    line 56
  14. Very specific:

    Keep arm64 and x86_64 appcast enclosures in separate <item> elements.

    line 57
  15. Very specific:

    If Homebrew does not link the tools, the script searches /opt/homebrew/Caskroom/sparkle/*/bin/ for them.

    line 58
  16. Very specific:

    Use SPARKLE_PRIVATE_KEY_FILE=<key> ./scripts/generate-appcast.sh --version <version> arm64.zip x86_64.zip for local appcast diagnosis.

    line 59

“Common” is measured: kept by at least 6 in 10 of the 183 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

Cutting a cctop Release

Releases are triggered by pushing a v* tag. .github/workflows/release.yml then runs: build (arm64 + x86_64, zip + DMG each) -> sign and notarize -> create GitHub Release -> update Sparkle appcast on master -> update Homebrew cask.

Authorization and checks

  • Treat an explicit request to release, cut, or ship a version as authorization for the complete release: assess scope, run proportionate checks, bump and land the version, push the tag, supervise publication, and verify downstream metadata. Do not insert another routine approval gate when all expected checks pass.
  • A request to prepare, assess, or check whether ready is not publication authorization. Stop before the tag and ask for the final go.
  • Before proposing or adding any release check, state its reason in plain language: name the concrete failure or release risk it covers and why the shipped changes make that risk relevant. Do not propose a check merely because an older or larger release used it.
  • Scale checks to the release. Previously approved PR tests are feature evidence; release checks should cover integration, versioning, packaging, and risks introduced by the exact release range. Patch releases should not inherit major-release manual tests without a specific reason.
  • Once an authorized release's checks pass, continue automatically. Stop only when a check fails unexpectedly, the release range/version is ambiguous, unrelated changes appear, publication requires a genuinely new product decision, or the developer asks to pause.
  • Never merge feature PRs; the developer merges them. The approved release bump may land by the agreed repository path.

1. Establish the release contract

  1. Sync and review what's shipping: git pull then git log $(git describe --tags --abbrev=0)..origin/master --oneline.
  2. Propose or confirm the semver bump and a short changelog summary.
  3. State how the bump commit will land. Direct push to master is allowed for this repo; most releases use this path. Use a PR if the developer prefers.
  4. List the release checks and give one concise reason for each. Remove checks whose reason is only habit or duplication of already-approved feature evidence.
  5. If the developer explicitly requested the release and the version/scope are clear, continue. If they only requested preparation/readiness assessment, stop for approval.

2. Bump the version

  • Always use scripts/bump-version.sh <version>; never edit version numbers by hand. The script updates the Xcode project, Config.hookVersion, plugin manifests, packaging, and the site fallback badge together.
  • Run make all (lint + contract + build + test) before committing.
  • Commit Bump version to <version> and land it per step 1.
  • If a PR was used: monitor CI to green, then stop and let the developer merge.

3. Confirm green

  • Wait for master CI on the bump commit: gh run list --branch master --limit 5, then gh run watch <id>.
  • For an explicitly authorized release, continue to the exact tag as soon as expected checks and master CI pass.
  • For preparation/readiness-only work, report the exact candidate and stop for tag authorization. The tag push publishes the release, appcast update, and cask bump.

4. Tag and monitor the pipeline

git tag v<version> && git push origin v<version>
  • Monitor the Release workflow to completion (gh run watch, or poll gh run list --workflow release.yml with retry/backoff on transient gh failures).
  • Do not name shell variables status; it is readonly in zsh and has silently broken CI watchers before.
  • If any job fails, stop immediately and report the exact failure with logs. Use the signing and appcast rules below for local diagnosis.

Signing and appcast rules

  • Sign Sparkle components without the app's entitlements. Apply entitlements only to the main executable and the app bundle.
  • Sign from the inside out: libraries, inner executables, nested bundles, the main executable, and then the app bundle.
  • Search Sparkle.framework/Versions/B/Autoupdate for executable components. This path has no MacOS directory.
  • Use ./scripts/sign-and-notarize.sh --dry-run dist/cctop.app to inspect signing order.
  • Use --sign-only only for local signing diagnosis. It does not prove notarization.
  • Keep arm64 and x86_64 appcast enclosures in separate <item> elements. Sparkle selects hardware at the item level.
  • If Homebrew does not link the tools, the script searches /opt/homebrew/Caskroom/sparkle/*/bin/ for them.
  • Use SPARKLE_PRIVATE_KEY_FILE=<key> ./scripts/generate-appcast.sh --version <version> arm64.zip x86_64.zip for local appcast diagnosis.

5. Verify

  • gh release view v<version> lists all four assets: cctop-macOS-{arm64,x86_64}.{zip,dmg}.
  • appcast.xml on master has separate arm64 and x86_64 <item> entries for the new version. CI commits this; pull and check.
  • The Homebrew cask job succeeded.
  • Report the release URL and what was verified.

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.