SuperAPI AI Directory
Partner中文AI newsFavorites
Skillsrelease-notes

release-notes

Deployment & operations

View repository

Updated 10-16 08:49

About this skill

Mole release notes

This skill drives the curated-notes step that runs after release.yml has finished. The workflow creates the GitHub Release with assets but with generate_release_notes: false, so notes must be added in a follow-up gh release edit (never gh release create, the release already exists, and create will conflict).

Inputs to gather

Before drafting, confirm:

  1. Version. Capital V, e.g. V1.38.0. Lowercase v does not trigger the workflow and may indicate a botched tag.
  2. CodeName + emoji. Ask the user. The title format is V<version> <CodeName> <emoji>.
  3. Release commit range. git log <previous-tag>..V<version> --oneline gives the raw material.
  4. User-visible behavior changes. Scan the full commit message bodies (not just subjects) for narrowed detection, removed features, or controlled regressions. These belong in notes even when they are not bug-fix-shaped, because users will encounter the changed boundary in production.
  5. Issue reporters and PR contributors in this cycle. Derive them from what the release actually contains, never from a date window of closed issues: git log --format='%an' <prev>..<tag> for contributors, and the issue numbers the range's own commit messages cite for reporters, checking each is state_reason: completed and was fixed here rather than merely referenced as background. A closing window silently pulls in not_planned issues and everything the PREVIOUS release fixed, which is how V1.55.0 nearly shipped 30 names where 8 were real. Keep it short, for example Issue reporters and PR contributors this cycle: @a · @b. Exclude tw93, youxi798 and bots.
  6. Verify release exists. gh release view V<version> --repo tw93/Mole --json id,name should return non-empty. If it doesn't, the workflow hasn't finished, wait, don't gh release create.

Pre-flight (published-tag evidence)

Use the target tag's exact commit and the completed checks and public-asset evidence from release-flow. Reuse that evidence when it still matches the immutable tag; rerun only a missing or failed gate. A build of a newer working tree does not verify the release being described. The full build, test, asset, and script-update gates stay owned by release-flow rather than a second checklist here.

If evidence is missing, complete the applicable release-flow gate before publishing notes. Keep draft work read-only; an existing release object alone is not proof its assets or upgrade path passed.

Format

Strictly follow the current compact release shape. Read the previous published stable release before the target tag as the live format reference. Exclude the candidate release: the workflow may already have made it the latest release with an empty body. Resolve the previous tag first, then read it with gh release view <previous-tag> --repo tw93/Mole --json tagName,body.

Structure:

<div align="center">
  <img src="https://cdn.tw93.fun/pic/cole.png" alt="Mole Logo" width="120" height="120" style="border-radius:50%" />
  <h1 style="margin: 12px 0 6px;">Mole</h1>
  <p><em>Deep clean and optimize your Mac.</em></p>
</div>

### Changelog

1. **<English headline>**: <one-sentence English elaboration>.
2. ...

### 更新日志

1. **<中文 headline>**：<一句中文说明>。
2. ...

### Thanks

Issue reporters and PR contributors this cycle: @handle1 · @handle2.

### Mole Mac App

Prefer a GUI? [Mole Mac App](https://mole.fit/) brings cleaning, app management, maintenance, disk analysis, and live system status into one native app, with review before deletion and a customizable menu bar HUD. It is $19 once, with lifetime updates and a 14-day refund. [Download and try it](https://mole.fit/download). The CLI stays free and open source.

No --- separators between sections, and no trailing repository link; the published pages end on the Mole Mac App line.

Format rules (all are documented bugs that have shipped before)

  • Body h1 is just Mole. Version, codename, and emoji live only in the --title argument (V<version> <CodeName> <emoji>); repeating them in the body header is redundant and has been explicitly rejected before.
  • No em dash anywhere. Use commas, periods, colons, semicolons, or parentheses.
  • No sponsor list by default. The current public release style thanks issue reporters and PR contributors for this cycle only.
  • No emoji except the version emoji in the release title. Body section headers stay plain, including ### Thanks (the old Thanks 💖 header is gone from the published pages).
  • No inline PR refs, no inline @handle thanks. PRs and people belong in the dedicated Thanks block only.
  • English block first, Chinese block second. Same numbered order in both blocks. Same number of items.
  • Order items by user-perceived impact, not commit chronology. Headline change first; internal safety hardening, performance, and bug fixes follow.
  • Do not describe overview icons that no longer exist. Analyze overview rows are text-only because emoji width and baselines vary across terminals. If icons return later, they must not imply that user data such as iOS Backups, Xcode Archives, or Old Downloads is safe to delete.
  • Verify every command mentioned in the notes actually exists in HEAD. The deleted mo check / mo doctor commands nearly shipped in notes as a "feature" after they were removed.
  • An incident or troubleshooting note is one sentence of symptom plus one command. No cause taxonomy, no command per branch; the user needs the one line that gets them unstuck. Match the previous release's language treatment for that note: if the last release carried it in one language, do not add a second.
  • Keep the Mole Mac App cross-link to one restrained, fact-backed paragraph. Validate the product scope, price, updates, refund window, and download URL against the current homepage before publishing.

Publish

Once the user approves the draft:

gh release edit V<version> --repo tw93/Mole \
  --title "V<version> <CodeName> <emoji>" \
  --notes-file <path-to-draft>

Never gh release create, it conflicts with the release the workflow already made.

Then add the six reactions with this skill's helper (path is relative to this SKILL.md, not the repo-root scripts/): bash "$(dirname <this SKILL.md>)/scripts/post-reactions.sh" V<version>.

After publish

  • gh release view V<version> --repo tw93/Mole --web (open in browser) so the user can eyeball it.
  • Remind the user: the Homebrew Core PR is workflow-driven and should already be in flight; do not re-run it manually unless the workflow log shows a failure.

When NOT to act

This skill is user-invocable only. It must not run unprompted:

  • If the user mentions release notes in passing, draft only; do not call gh release edit.
  • If gh release view shows the release does not exist yet, wait for the workflow; do not create a competing release manually.
  • If the user has not given an explicit "publish" / "submit" signal, stop after the draft.

Helper script

scripts/post-reactions.sh <tag> lives next to this SKILL.md and adds the six reactions (+1, laugh, hooray, heart, rocket, eyes) to the release.