Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (26 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.5 KB

Cutting a new release

  1. Update the version number in package.json.
  2. Go to Draft a new release in the Releases page.
  3. Make sure that the Publish this Action to the GitHub Marketplace checkbox is enabled

Screenshot 2022-06-15 at 12 08 19

  1. Click "Choose a tag" and then "Create new tag", where the tag name will be your version prefixed by a v (e.g. v1.2.3).
  2. Use a version number for the release title (e.g. "1.2.3").

Screenshot 2022-06-15 at 12 08 36

  1. Add your release notes. If this is a major version make sure to include a small description of the biggest changes in the new version.
  2. Click "Publish Release".

You now have a tag and release using the semver version you used above. The last remaining thing to do is to move the dynamic version identifier to match the current SHA. This allows users to adopt a major version number (e.g. v1) in their workflows while automatically getting all the minor/patch updates.

To do this just checkout main, force-create a new annotated tag, and push it:

git tag -fa v3 -m "Updating v3 to 3.0.1"
git push origin v3 --force