Skip to content

Commit e570ca6

Browse files
authored
Merge branch 'master' into feat/accessible-orgs-hook
Signed-off-by: Rishi Raj <[email protected]>
2 parents 4bd31cf + 982b2ad commit e570ca6

54 files changed

Lines changed: 2502 additions & 727 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.agents/skills/cut-release/SKILL.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
44
user-invocable: true
55
---
66

@@ -14,28 +14,36 @@ Publishes a new version of the `@sistent/sistent` npm package. Releasing is **au
1414

1515
## The release chain (what actually happens)
1616

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).
1818
2. **You publish the draft Release.** The tag (e.g. `v0.21.31`) becomes the version source of truth.
1919
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.
2020
4. `notify-dependents.yml` fires on the publish workflow's success and bumps downstream consumers (e.g. meshery, meshery-cloud) to the new version.
2121

2222
## Procedure
2323

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.
2525

2626
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:
2727
```bash
2828
gh release list --repo layer5io/sistent # find the draft (isDraft = true)
2929
gh release view <vX.Y.Z> --repo layer5io/sistent # confirm version + notes
3030
```
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.
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.
3238

3339
2. **Publish the draft Release. That's it.** No version editing, no notes, no tagging:
3440
```bash
3541
gh release edit <vX.Y.Z> --repo layer5io/sistent --draft=false --latest
3642
```
3743
Publishing triggers `release.yml`, which publishes to npm and auto-merges the version-bump-back PR.
3844

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+
3947
## Verify
4048

4149
1. Watch the publish workflow to success:
@@ -52,7 +60,7 @@ The only human step is publishing the drafted release — Release Drafter has al
5260
## What NOT to do
5361

5462
- ❌ 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.
5664
- ❌ 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.
5765
- ❌ Don't republish an already-published npm version — npm publishes are effectively permanent; cut a new patch instead.
5866

0 commit comments

Comments
 (0)