Skip to content

docs: describe the release process in the README - #9

Merged
Mearman merged 1 commit into
mainfrom
docs/release-process
Oct 2, 2026
Merged

Mearman merged 1 commit into
mainfrom
docs/release-process

Conversation

@Mearman

@Mearman Mearman commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Adds a Releases section to the README covering how a release happens today: semantic-release on main, npm trusted publishing with provenance, and the release commit and tag pushed over SSH with a deploy key that is only provisioned for the release step. It also notes the ruleset on main that the key bypasses. The existing text about the release job's runner and deploy key moved under the new heading as it was. This is a patch-level docs change, so it also exercises the release push against the protected branch.

Covers semantic-release on main, trusted publishing with provenance,
the SSH push of the release commit and tag with a deploy key, and the
ruleset that key bypasses.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review ✅ Completed 2026-10-02T08:13:56.684745Z 4e0d051 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Mearman
Mearman merged commit 03b6a99 into main Oct 2, 2026
12 checks passed
@Mearman
Mearman deleted the docs/release-process branch October 2, 2026 08:27
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 1.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant