Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.18 KB

RELEASING.md

File metadata and controls

41 lines (26 loc) · 1.18 KB

Guide on how to release Time to Leave:

First, make sure the changelog.md displays the correct new version (## X.Y.Z (in development)).

  1. Update package.json to the release version (no -dev)
  2. git commit -am "Release vX.Y.Z"
  3. git tag -a stable/vX.Y.Z
  4. git push origin main stable/vX.Y.Z

This will trigger the release action which creates a draft for the release notes.

If something goes wrong:

  1. Delete tag locally: git tag --delete stable/v3.0.0
  2. Delete tag on remote: git push --delete origin stable/v3.0.0

Try again :)

After publushing the release:

  1. Bump changelog.md to developer version (version + 1)-dev. Use the following template:
## X.Y.Z (in development)

<!--- Begin changes - Do not remove -->

<!--- End changes - Do not remove -->

Who built X.Y.Z:

<!--- Begin users - Do not remove -->

<!--- End users - Do not remove -->
  1. Bump package.json to developer version (version + 1)-dev
  2. Bump the links in website/src/index.html (search for the old version tag)
  3. git commit -am "Bump to version vX.Y.Z-dev"
  4. git push
  5. Create PR in HomeBrew cask updating version. See example.