diff --git a/README.md b/README.md index b85d15d3c3f86..7c47621536388 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,12 @@ 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. 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 update the base branch of these pull requests onto `develop` and merge them, and then create a new pull request to merge `develop` into `master`. Then, the `release` workflow will trigger the actual publishing to `npm` and Docker hub. + +Be sure to not merge other pull requests into `develop` if partially through the release process. This can cause problems with Changesets doing releases and will require manual intervention to fix it. + ### Release candidate branches Branches marked `regenesis/X.X.X` are **release candidate branches**.