Commit 1f096032 authored by Liam Horne's avatar Liam Horne Committed by GitHub

doc: add notes for releasing new versions with changesets (#1166)

parent 9583c33f
...@@ -209,6 +209,10 @@ Some exceptions to this rule exist for cases in which we absolutely must deploy ...@@ -209,6 +209,10 @@ Some exceptions to this rule exist for cases in which we absolutely must deploy
If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using the latest release candidate branch. If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using the latest release candidate branch.
See below for info about release candidate branches. See below for info about release candidate branches.
### Release new versions
Developers can release new versions of the software by adding changesets to their pull requests using `yarn changeset`. Changesets will persist over time on the `develop` branch without triggering new version bumps to be proposed by the Changesets bot. Once changesets are merged into `master`, the bot will create a new pull request called "Version Packages" which bumps the versions of packages. The correct flow for triggering releases is to re-base these pull requests onto `develop` and merge them, and then create a new pull request to merge `develop` onto `master`. Then, the `release` workflow will trigger the actual publishing to `npm` and Docker hub.
### Release candidate branches ### Release candidate branches
Branches marked `regenesis/X.X.X` are **release candidate branches**. Branches marked `regenesis/X.X.X` are **release candidate branches**.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment