docs: document the version release process#101
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.jsonremains1.0.0). - Added step-by-step commands for building/validating
dist/index.mjs, creating annotated tags, and pushing tags (including force-updatingv1).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
### Releasingsubsection under## Developmentin the README, capturing the current release process:package.jsonstays at1.0.0.@v1(or pin a SHA), so each release movesv1forward.mainand confirmdist/index.mjsis in sync, create the annotatedv1.x.0version tag (minor bump), move thev1major tag to the same commit, then push the new tag and force-pushv1.Documents the process just used to cut
v1.13.0.