From 76e94ab539da9df25f820e16f8dd39575755d930 Mon Sep 17 00:00:00 2001 From: Steven DeMartini Date: Wed, 11 Sep 2024 19:55:34 -0700 Subject: [PATCH] Suggest pushing specific tag instead of all tags for releasing Avoid mistakenly pushing other tags, like what happened as mentioned here https://github.com/sjdemartini/mui-tiptap/pull/267#issuecomment-2344978118 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 80962d5..f8ae814 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 `, 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.