agentleFS
patnikopatniko/whim/.github/skills/create-release/SKILL.md

create-release

Skill4 starsChanged 5 months agoMITView on GitHub

Use this skill to cut a new whim release and publish it with proper release notes. Triggers: 'create a release', 'cut a release', 'publish a new version', 'ship vX.Y.Z', 'bump the version and release', 'release notes for the release', or any request to run/repair the GitHub release for patniko/whim. Drives the full flow — version bump, tag, trigger release.yml, and attach generated notes — and can also backfill notes onto an existing release.

  • Commits and pushes

19 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use create-issue, create-pr and 1 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.
  • sahinSkill

    create-issue

    Also in 4 projects that use this

  • SentrySkill

    create-pr

    Create pull requests following Sentry conventions. Use when opening PRs, writing PR descriptions, or preparing changes for review. Follows Sentry's code review guidelines.

    Also in 5 projects that use this

  • DockerSkill

    review-pr

    Review one or more incoming Docker documentation pull requests as a maintainer. Independently validate technical claims, assess editorial fit and information architecture, choose a verdict, and draft exact inline or PR-wide feedback behind a confirmation gate. Use for requests such as "review PR 123", "is this PR correct?", "does this information belong here?", "validate this PR", or "help review backlog PRs". Do not use to maintain or fix a PR you own; use maintain-pr for that.

    Also in 4 projects that use this

  • Other versions19 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 0

    None found.

    Wrote their own version · 19

    1. Saptha-me/Bindu★ 10ksame name
    2. GetBindu/Bindu★ 10ksame name
    3. IndrajeetPatil/ggstatsplot★ 2.2ksame name
    4. mlightcad/cad-viewer★ 1.2ksame name
    5. epam/ketcher★ 932same name
    6. Azure/azure-service-operator★ 916same name
    7. fpindej/netrock★ 234same name
    8. microsoft/BC-Bench★ 61same name
    9. glowingkitty/OpenMates★ 53same name
    10. richkuo/rk-skills★ 50same name

    9 more not listed

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 18 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If a precondition fails, report exactly what's wrong and stop.

    line 28
  2. Very specific:

    Read the current version: node -p "require('./package.json').version".

    line 34
  3. Distinctive:

    Run the helper for the new range and capture its output:

    line 57
  4. Very specific:

    Follow .github/skills/create-release/references/notes-template.md.

    line 70
  5. Very specific:

    Wait for the run to finish (both release-mac and release-win):

    line 79
  6. Very specific:

    If a job fails, surface the failing logs (gh run view <run-id> --log-failed), fix or advise, and re-run before continuing.

    line 86
  7. Very specific:

    Never change productName/appId or add per-script productName overrides — see the warning in RELEASING.md (it breaks macOS auto-updates).

    line 123

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

Create a whim release

End-to-end release for patniko/whim: bump the version, push the tag, trigger the signed multi-platform build (.github/workflows/release.yml), and guarantee the GitHub Release has real notes. electron-builder publishes the release with an empty body, so this skill writes the notes itself, after the workflow finishes, via gh release edit (so the body can't be overwritten).

When to use

  • The user wants to ship a new version of whim.
  • The user wants to (re)generate or fix release notes for a release.
  • A release was published with an empty body and needs notes backfilled.

Prerequisites (verify first, stop if any fail)

  1. gh auth status succeeds (and gh repo view patniko/whim works).
  2. Working tree is clean: git status --porcelain is empty.
  3. On the default branch and up to date: git rev-parse --abbrev-ref HEAD is master, and git fetch && git status -sb shows no divergence from origin/master.
  4. Node is available (run node -v) — needed for the notes helper.

If a precondition fails, report exactly what's wrong and stop; do not push anything.

Procedure

1. Choose the version (auto-patch, then confirm)

  • Read the current version: node -p "require('./package.json').version".
  • Compute the next patch by default (e.g. 0.0.14 → 0.0.15).
  • Show the proposed version and ask the user to confirm or override (they may pick a minor/major bump or an explicit version). Do not write anything until confirmed.
  • The tag is v<version> (e.g. v0.0.15).

2. Stamp the version and push the tag

Only after confirmation:

npm version <version> --no-git-tag-version   # updates package.json (+ lockfile)
git add package.json package-lock.json
git commit -m "v<version>"
git tag "v<version>"
git push origin master --tags

npm version <version> --no-git-tag-version just edits the files; we commit/tag explicitly to match the vX.Y.Z commit-message convention in RELEASING.md.

3. Generate the release notes

Run the helper for the new range and capture its output:

node .github/skills/create-release/scripts/generate-notes.js \
  --from "v<previousVersion>" --to "v<version>" > /tmp/whim-notes.md

(Omit --from/--to to auto-detect the latest tag and the one before it. Add --enrich-prs to pull PR titles via gh, best-effort.)

Then write the summary: open /tmp/whim-notes.md, replace the <!-- Write 1–2 sentences… --> placeholder under ## Summary with a concise, user-facing 1–2 sentence description of the release, and tidy any awkward entries. Follow .github/skills/create-release/references/notes-template.md. Never ship the placeholder comment.

4. Trigger the build workflow

gh workflow run release.yml --field tag="v<version>"

Wait for the run to finish (both release-mac and release-win):

gh run list --workflow=release.yml --limit 1                  # get the run id
gh run watch <run-id> --exit-status                           # blocks until complete

If a job fails, surface the failing logs (gh run view <run-id> --log-failed), fix or advise, and re-run before continuing.

5. Attach the notes (after publish)

Once the workflow succeeds and the release exists:

gh release edit "v<version>" --notes-file /tmp/whim-notes.md --latest --draft=false

Doing this after the workflow ensures electron-builder can't clobber the body.

6. Verify

gh release view "v<version>" --json tagName,name,isDraft,body \
  --jq '{tag:.tagName, draft:.isDraft, hasNotes:(.body|length>0)}'
gh release view "v<version>"   # eyeball assets: .dmg, .zip, .exe, latest-mac.yml, latest.yml

Confirm hasNotes is true and the expected assets are present. Report the release URL.

Backfilling notes on an existing release

To add/replace notes without cutting a new build (e.g. a release published with an empty body):

node .github/skills/create-release/scripts/generate-notes.js \
  --from "v<previous>" --to "v<target>" > /tmp/whim-notes.md
# write the Summary, then:
gh release edit "v<target>" --notes-file /tmp/whim-notes.md --latest

Notes & guardrails

  • Never change productName/appId or add per-script productName overrides — see the warning in RELEASING.md (it breaks macOS auto-updates).
  • Signing/notarization happens in CI via repo secrets; nothing secret is needed locally.
  • Releases are cut from master. The notes helper is plain Node (no deps) and is safe to run anywhere.
  • Clean up /tmp/whim-notes.md when done.

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.