Skip to content

Commit

Permalink
Suggest pushing specific tag instead of all tags for releasing
Browse files Browse the repository at this point in the history
Avoid mistakenly pushing other tags, like what happened as mentioned
here
#267 (comment)
  • Loading branch information
sjdemartini committed Sep 12, 2024
1 parent 60ae41b commit 76e94ab
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ When a new version should be cut since some new changes have landed on the `main
1. Go to the `main` branch and pull in the latest changes.
2. Run `npm version <major | minor | patch | premajor | preminor | prepatch | prerelease>`, depending on what's appropriate per semver conventions for the latest changes.
- This will create a commit that updates the `version` in `package.json`, and add a git tag for that new commit.
3. Push the commit and tags (ex: `git push origin main` and `git push --tags`)
3. Push the commit and tag (ex: `git push origin main` and `git push origin refs/tags/v0.0.0`, where `v0.0.0` is the new version number/tag).
4. The `release.yml` GitHub Actions workflow will run and should publish to npm upon completion.
5. Once the new version has been successfully published to npm, create a "Release" in GitHub for to the newly pushed tag, per the steps [here](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), which can auto-generate release notes that can be edited and cleaned up for clarity and succinctness.

0 comments on commit 76e94ab

Please sign in to comment.