You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit e570ca6
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .agents/skills/cut-release/SKILL.md
+13-5Lines changed: 13 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
name: cut-release
3
-
description: Runbook for cutting a release of @sistent/sistent to npm. Use when asked to "cut a release", "release Sistent", "publish a new version", or "ship the next @sistent/sistent". The flow is: wait for Release Drafter to fold the merged PR into the draft release, then publish that draft — Release Drafter has already set the version and notes, and release.yml handles the npm publish (OIDC provenance) and the auto-merged version-bump-back.
3
+
description: Runbook for cutting a release of @sistent/sistent to npm. Use when asked to "cut a release", "release Sistent", "publish a new version", or "ship the next @sistent/sistent". The flow is: wait for Release Drafter to fold the merged PR into the draft release, then publish that draft - Release Drafter has already set the version (from the merged PR's labels) and the notes, and release.yml handles the npm publish (OIDC provenance) and the auto-merged version-bump-back.
4
4
user-invocable: true
5
5
---
6
6
@@ -14,28 +14,36 @@ Publishes a new version of the `@sistent/sistent` npm package. Releasing is **au
14
14
15
15
## The release chain (what actually happens)
16
16
17
-
1.**A PR merges to `master`** → `release-drafter.yml` runs and updates the **draft GitHub Release**: it folds that PR into the changelog and computes the next version from the PR's labels (major / minor / patch).
17
+
1.**A PR merges to `master`** → `release-drafter.yml` runs and updates the **draft GitHub Release**: it folds that PR into the changelog and computes the next version from the PR's labels (`major` / `minor` / `patch`, defaulting to `patch` when unlabelled).
18
18
2.**You publish the draft Release.** The tag (e.g. `v0.21.31`) becomes the version source of truth.
19
19
3. Publishing emits `release: published` → **`release.yml`**: sets `package.json#version` from the tag, `npm ci` → `npm run build` → `npm publish --provenance --access public`, then opens the `release/version-bump/vX.Y.Z` PR and **auto-merges it** so `master`'s `package.json`/`package-lock.json` track the published version without sitting idle.
20
20
4.`notify-dependents.yml` fires on the publish workflow's success and bumps downstream consumers (e.g. meshery, meshery-cloud) to the new version.
21
21
22
22
## Procedure
23
23
24
-
The only human step is publishing the drafted release — Release Drafter has already done the versioning and notes.
24
+
The only human step is publishing the drafted release - Release Drafter has already done the versioning and notes.
25
25
26
26
1.**Wait for Release Drafter to fold your merged PR into the draft.** After the PR merges to `master`, `release-drafter.yml` runs (a few seconds). Confirm the draft now reflects the merged PR and shows the intended next version:
27
27
```bash
28
28
gh release list --repo layer5io/sistent # find the draft (isDraft = true)
If the version bump is wrong, it's driven by the merged PR's labels — relabel and let Release Drafter re-draft; do not hand-edit the tag.
31
+
If the version bump is wrong, it's driven by the merged PR's labels - relabel and let Release Drafter re-draft; do not hand-edit the tag. Which label a breaking change gets is the pre-1.0 rule in [`AGENTS.md`](../../../AGENTS.md)'s Releasing section.
32
+
33
+
Relabelling alone does **not** re-draft: `release-drafter.yml` runs on push to `master`, so nothing re-runs it after the merge. Re-run it by hand once the label is right:
34
+
```bash
35
+
gh workflow run release-drafter.yml --repo layer5io/sistent --ref master
36
+
```
37
+
Then re-check the draft with `gh release view` before publishing.
32
38
33
39
2.**Publish the draft Release. That's it.** No version editing, no notes, no tagging:
Publishing triggers `release.yml`, which publishes to npm and auto-merges the version-bump-back PR.
38
44
45
+
> **A label-driven minor or major has never actually been drafted in this repo.** Until the config change alongside this note, the name and tag templates interpolated `$NEXT_PATCH_VERSION`, so `version-resolver` was inert and every `v0.21.*` release drafted as a patch regardless of labels (`v0.21.0` and the boundaries below it were created by hand). The first non-patch draft is worth confirming against step 1 before publishing rather than assuming.
46
+
39
47
## Verify
40
48
41
49
1. Watch the publish workflow to success:
@@ -52,7 +60,7 @@ The only human step is publishing the drafted release — Release Drafter has al
52
60
## What NOT to do
53
61
54
62
- ❌ Don't `npm publish` locally or `npm version`-tag by hand — the workflow owns publishing (with provenance) and the version comes from the release tag.
55
-
- ❌ Don't edit the draft's version or release notes — Release Drafter owns both; fix PR labels instead.
63
+
- ❌ Don't edit the draft's version or release notes - Release Drafter owns both; fix PR labels instead.
56
64
- ❌ Don't publish expecting an unmerged PR to be included — the release ships `master`'s current state; merge first, then let Release Drafter update the draft.
57
65
- ❌ Don't republish an already-published npm version — npm publishes are effectively permanent; cut a new patch instead.
0 commit comments