Skip to content

Releases

Jump to bottom
fboucquez edited this page Mar 16, 2022 · 5 revisions

Alpha pre-releases

Every time the dev branch is updated, for example, once a feature or bug pull request has been merged, GitHub actions will automatically push an alpha artifact into the NPM repository.

To install the latest pre-release alpha, run:

npm install -g symbol-bootstrap@alpha

This allows the community to test a feature before a full version-increase release.

Alpha pre-releases don't increase the artifact version.

Regular releases

Once the dev branch has enough well tested features that can be released, the process to release is the following:

  1. Review Changelog:

Add or review a changelog line into dev branch latest CHANGELOG.md

  1. Push dev branch into main:

With a Dev -> Main PR or just directly with:

git checkout dev
git pull
git push origin dev:main

Use fast-forward if possible. Be sure main is up-to-date with dev.

  1. Release using GitHub Actions:

Go to the release workflow. Click on Run Workflow, select the main branch and run it.

  1. Review and release in GitHub Releases:

The workflow action should have created a draft release. Review the subject, update the body and click release.

  1. Push main branch into dev:

The workflow action should have increased and committed the patch version into main. Merge it to dev with a Main -> Dev PR or with:

git checkout main
git pull
git push origin main:dev

Use fast-forward if possible.

To install the latest release, run:

npm install -g symbol-bootstrap

HotFix releases

If the dev branch has some features that are not ready to be released yet, and there is a critical bug to be fixed in prod. You need to:

  1. Create the HotFix PR and merge it into the main branch.

  2. Review Changelog:

Add or review a changelog line into main branch latest CHANGELOG.md

  1. Release using GitHub Actions:

Go to the release workflow. Click on Run Workflow, select the main branch and run it.

  1. Review and release in GitHub Releases:

The workflow action should have created a draft release. Review the subject, update the body and click release.

  1. Merge main branch into dev:

The main branch should have the fix and the new minor version upgrade. Merge it to dev with a Main -> Dev PR (no squash).

To install the latest release, run:

npm install -g symbol-bootstrap
Clone this wiki locally