Skip to content

docs: document the version release process#101

Merged
fengmk2 merged 1 commit into
mainfrom
docs/release-process
Jul 1, 2026
Merged

docs: document the version release process#101
fengmk2 merged 1 commit into
mainfrom
docs/release-process

Conversation

@fengmk2

@fengmk2 fengmk2 commented Jul 1, 2026

Copy link
Copy Markdown
Member

Adds a ### Releasing subsection under ## Development in the README, capturing the current release process:

  • Releases are published as git tags only; there is no npm package, so package.json stays at 1.0.0.
  • Consumers reference the moving major tag @v1 (or pin a SHA), so each release moves v1 forward.
  • Steps: sync main and confirm dist/index.mjs is in sync, create the annotated v1.x.0 version tag (minor bump), move the v1 major tag to the same commit, then push the new tag and force-push v1.

Documents the process just used to cut v1.13.0.

Copilot AI review requested due to automatic review settings July 1, 2026 04:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation to the README describing how this GitHub Action is released and versioned via git tags (including updating the moving v1 major tag), aligning the process with how consumers reference the action.

Changes:

  • Documented that releases are git tags only (no npm package; package.json remains 1.0.0).
  • Added step-by-step commands for building/validating dist/index.mjs, creating annotated tags, and pushing tags (including force-updating v1).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
@fengmk2 fengmk2 merged commit a9a1f8d into main Jul 1, 2026
35 checks passed
@fengmk2 fengmk2 deleted the docs/release-process branch July 1, 2026 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants