release-docs
Cut a release: bump version, update docs, tag, and push. Invoke with /release-docs vX.Y.Z.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
القائمة
Cut a release: bump version, update docs, tag, and push. Invoke with /release-docs vX.Y.Z.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | release-docs |
| description | Cut a release: bump version, update docs, tag, and push. Invoke with /release-docs vX.Y.Z. |
Usage: /release-docs vX.Y.Z
The version must be a semver bump after the latest tag. The workflow:
bun run set-version <version>.bun run check (typecheck + tests) — abort on failure.git fetch --tags --quiet
LATEST_TAG=$(git tag --sort=-v:refname | sed -n 1p)
The argument (e.g. v0.1.3) must be a valid semver tag that sorts after
$LATEST_TAG. Compare with git tag --sort=-v:refname to confirm.
If the argument is not the immediate next version, surface the full tag list
and ask the user to confirm anyway. Accept --force-like override only with
explicit user consent.
Show the plan:
Release: <version>
Range: <LATEST_TAG>..HEAD
Commits: <count>
Ask "Ready to cut this release?" before proceeding.
bun run set-version <version-without-v>
This updates package.json (source of truth), src-tauri/Cargo.toml,
src-tauri/Cargo.lock, and src-tauri/tauri.conf.json.
git log --no-merges --no-decorate "$LATEST_TAG..HEAD" \
--pretty=format:'%n=== %h %s ===%n%b'
git log --no-merges --stat --oneline "$LATEST_TAG..HEAD"
Read the actual diffs for anything ambiguous (git show <hash>). Sort the
changes into buckets:
Ignore version-bump / release-plumbing commits — they aren't release notes.
Work in this order. After each file, note what you changed for the final summary.
/Users/andreabruno/Products/lopload/CHANGELOG.mdAdd a new section directly under the intro paragraph, above the previous release. Match the existing format exactly:
## [X.Y.Z] — YYYY-MM-DD
<one-line release theme, optional>
- Bullet per user-facing change, present-tense, user's-eye view
v.0.1.0 entry is preferred./Users/andreabruno/Products/lopload/README.mdOnly edit if the release changed something the README states: the one-line pitch, the Quick Start commands, or the Features list. Do not add a changelog here or bump badges (they're dynamic). Leave it untouched if the release was internal.
/Users/andreabruno/Products/lopload/AGENTS.mdThe developer/agent guide. Update only the sections a commit invalidated: Quick start commands, the credential-backend table, Architectural decisions, Directory layout, or dependency/toolchain notes. Keep its terse, factual voice. Never add release notes here — this file describes how the code works now, not what changed.
/Users/andreabruno/Products/lopload-docs/ (separate repo)Public docs, an Astro Starlight site. Content lives in
src/content/docs/:
guides/ — getting-started, installation, share-links, transfers, trashreference/ — auto-updates, security, troubleshootingUpdate the specific page(s) a user-facing change affects. If a release adds a whole new capability with no matching page, ask the user whether to add one rather than inventing structure. This is a different git repo — do not stage or commit it together with lopload; leave its changes in the working tree and mention them in the summary.
git add CHANGELOG.md README.md AGENTS.md package.json src-tauri/
git commit -m "chore: release <version>"
If README.md or AGENTS.md are unchanged, omit them from the add.
bun run check
If it fails, report the failure and stop — do not tag.
git tag -a <version> -m "<version>"
git push origin <version>
git push origin main