chore(skills): add /cut-release skill - #594
Conversation
Document how to cut a release of this repo by publishing the current Release Drafter draft. Rolled out from the meshery-cloud canonical template. Signed-off-by: Rian the rizzler <182301570+ritzorama@users.noreply.github.com>
📝 WalkthroughWalkthroughAdds a ChangesRelease skill documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Adds a new Claude skill (cut-release) documenting the repo’s release process so publishing the current Release Drafter draft is consistent and repeatable.
Changes:
- Introduces
.claude/skills/cut-release/SKILL.mdwith a step-by-step procedure for publishing the Release Drafter draft viagh. - Documents verification steps to ensure the Release Drafter run has completed and the draft notes include the latest merged PR before publishing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `.github/workflows/release-drafter.yml` runs on **every push to `master`**. As PRs | ||
| merge, it maintains a single **draft** GitHub Release whose tag auto-increments (the | ||
| patch version bumps after each publish). There is always exactly one draft waiting to | ||
| be published. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/cut-release/SKILL.md:
- Around line 23-26: Update the release-drafter description in the cut-release
skill to say it normally maintains one draft rather than asserting that exactly
one draft always exists. Preserve the later explicit draft-count check and its
documented zero-draft behavior.
- Around line 27-29: Update the release workflow documentation in SKILL.md to
capitalize “GitHub” correctly wherever the platform name appears, including the
“GitHub Actions” reference, without changing the surrounding release behavior
description.
- Around line 51-56: Update the release workflow instructions around the current
origin/master SHA to handle an absent workflow run before invoking gh run watch:
instruct the user to rerun or poll gh run list until the run appears, then pass
its database ID to gh run watch; retain the existing wait behavior for runs
already in_progress.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: dc5687cc-2c27-4fd1-a244-cd3201b79250
📒 Files selected for processing (1)
.claude/skills/cut-release/SKILL.md
| - `.github/workflows/release-drafter.yml` runs on **every push to `master`**. As PRs | ||
| merge, it maintains a single **draft** GitHub Release whose tag auto-increments (the | ||
| patch version bumps after each publish). There is always exactly one draft waiting to | ||
| be published. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Avoid asserting that a draft always exists.
This conflicts with the later documented zero-draft case at Lines 106-107 and can make users assume a release is available when none exists. Use “normally maintains one draft” and retain the explicit count check before publishing.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.claude/skills/cut-release/SKILL.md around lines 23 - 26, Update the
release-drafter description in the cut-release skill to say it normally
maintains one draft rather than asserting that exactly one draft always exists.
Preserve the later explicit draft-count check and its documented zero-draft
behavior.
| - Publishing that draft (the release `published` event) triggers | ||
| `.github/workflows/multi-platform.yml`, which builds the multi-architecture meshsync | ||
| container images and pushes them to the registry, tagged with the released version. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Capitalize “GitHub.”
Change “GitHub Actions” to use the platform’s official capitalization.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: The official name of this software platform is spelled with a capital “H”.
Context: ...the release published event) triggers .github/workflows/multi-platform.yml, which bu...
(GITHUB)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.claude/skills/cut-release/SKILL.md around lines 27 - 29, Update the release
workflow documentation in SKILL.md to capitalize “GitHub” correctly wherever the
platform name appears, including the “GitHub Actions” reference, without
changing the surrounding release behavior description.
Source: Linters/SAST tools
| If the run for the current `origin/master` SHA is still `in_progress` (or absent because the | ||
| push just landed), wait for it before publishing: | ||
|
|
||
| ```bash | ||
| gh run watch <databaseId> --exit-status | ||
| ``` |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Handle an absent workflow run before calling gh run watch.
When the run is absent, there is no <databaseId> to pass to gh run watch. Explicitly instruct the user to rerun or poll gh run list until the run appears, then watch that run.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.claude/skills/cut-release/SKILL.md around lines 51 - 56, Update the release
workflow instructions around the current origin/master SHA to handle an absent
workflow run before invoking gh run watch: instruct the user to rerun or poll gh
run list until the run appears, then pass its database ID to gh run watch;
retain the existing wait behavior for runs already in_progress.
What
Adds a
/cut-releaseskill at.claude/skills/cut-release/SKILL.mdso cuttinga release of this repo is consistent, documented, and delegatable.
Why
Releasing here is a single action: publish the current Release Drafter draft.
Release Drafter owns the tag and the notes (the patch version auto-increments), and
the
releasedevent drives the repo's downstream automation. This skill captures thatflow - wait for the drafter run to fold in the just-merged PR, confirm the draft, then
flip it to published - so anyone (human or agent) can run it the same way. Rolled out
from the canonical template in
layer5io/meshery-cloud.Scope
Documentation/tooling only - a single new skill file. No code or workflow changes.
Summary by CodeRabbit