Skip to content

Commit

Permalink
document releasing dist tags (#1083)
Browse files Browse the repository at this point in the history
  • Loading branch information
thescientist13 authored Apr 1, 2023
1 parent 93ed8d8 commit 7ff06de
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,15 +255,25 @@ Note: If you have issues running tests due to timeouts, you can increase the set
## Release Management
Lerna is used to manage the publishing of packages within the workspace under a single unified version. Assuming you are logged into **npm** locally and have 2FA access to publish, the command to run is
Lerna is used to manage the publishing of packages within the workspace under a single unified version. Assuming you are logged into **npm** locally and have 2FA access to publish, the following workflows should be used
After running these commands, Lerna should then prompt you through the steps to pick the version and all packages that will get updated.
### Alpha Release
Greenwood typically works on new minor versions in a dedicated branch and release line called "alpha". This leverages NPM's concept of dist tags. While on a release branch, run the following to publish a new _alpha_ release.

```sh
# from the root of the repo
$ yarn lerna publish
# if Lerna is not displaying all packages as needing publishing, cancel and use
$ yarn lerna publish --force-publish
$ yarn lerna publish --force-publish --dist-tag alpha
```

Lerna should then prompt you through the steps to pick the version and all packages that will get updated.
> Typically you will want to select the _Custom Preminor_ option from the list, which Lerna should appropriately yield the expected version.

### Standard Release

> _Sometimes when doing pre-minor releases, it will be required to manually bump the `version` in www/package.json_
For a normal release (e.g. "latest") the following command can be run from the mainline branch of the repo.
```sh
# from the root of the repo
$ yarn lerna publish --force-publish
```

0 comments on commit 7ff06de

Please sign in to comment.