Skip to content

Commit 2264f22

Browse files
docs(release): stop merges during a release and add the Marketplace step (#132)
A merge to main after the release commit stops the plan job. The procedure now tells the owner to stop other merges first. The new last section publishes the action to the GitHub Marketplace. Signed-off-by: Bart Waardenburg <bart@waardenburg.dev>
1 parent 39977c8 commit 2264f22

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

‎docs/release-procedure.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ commit collects the fragments.
8484

8585
## Prepare the release commit
8686

87+
From the merge of the release pull request until the tag push, `main` must
88+
not change. The `plan` job and `scripts/publish-github-release.mjs` stop when
89+
`origin/main` is not the release commit. Before step 1, stop each other
90+
session and pull request that can merge to `main`, also auto-merge.
91+
8792
1. Make a branch from the newest `main`: `git switch -c chore/release-vX.Y.Z`.
8893
2. Run `node scripts/changelog-fragments.mjs collect`. The command moves each
8994
fragment into `[Unreleased]` and deletes the fragment files.
@@ -195,6 +200,19 @@ release creation fails after the tag push, keep the signed tag. Remove only an
195200
incomplete draft, then run `gh release create` again with the same values.
196201
Never move or create the signed tag again.
197202

203+
## Publish the action to the GitHub Marketplace
204+
205+
The GitHub Marketplace reads `action.yml` at the release tag. Do this step
206+
after the release creation:
207+
208+
1. Open the release on GitHub and click **Edit**.
209+
2. Select **Publish this Action to the GitHub Marketplace**.
210+
3. Select a primary category, for example **Code quality**.
211+
4. Click **Update release**.
212+
213+
The Marketplace rejects a `description` of 125 characters or more.
214+
`action/tests/run.sh` fails before a release when the description is too long.
215+
198216
## Change the release environment after this procedure merges
199217

200218
The `release` environment admitted only the tag rule `v*` for the 0.1.0

0 commit comments

Comments
 (0)