Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.04 KB

RELEASE.md

File metadata and controls

24 lines (17 loc) · 1.04 KB
Raw

Releasing

NOTE: This project is currently in Beta phase

Manually

Generate a Github token which is required to create a release in the Github, the process is as follows:

  1. Be sure you have checked out the main branch and have pulled the latest changes
  2. Run the tests to make sure everything is green
  3. Bump the beta version by running npm version prerelease --preid=beta
  4. Run the release command using GH_TOKEN=<token> npm run release
  5. If release is successful, push commits and tags upstream with git push upstream main && git push upstream --tags

CI based

The release process is also automated in the way any specific commit from the main branch can be potentially released, for such it's required the below steps:

  1. Be sure you have checked out the main branch and have pulled the latest changes
  2. Bump the beta version by running npm version prerelease --preid=beta
  3. Push commits and tags upstream with git push upstream main && git push upstream --tags
  4. Wait for an email/slack to confirm the release is done.