Skip to content

Commit 9eec024

Browse files
committed
docs(CONTRIBUTING): sketch out release process
1 parent 7426d94 commit 9eec024

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Rough notes that should evolve into a better guide sometime.
2+
3+
## Publishing a release
4+
5+
```sh
6+
# Name a release branch
7+
now=`date -u +%Y%m%dT%H%M%S`
8+
git checkout -b prepare-release-$now
9+
git branch -u origin
10+
11+
# Install build dependencies
12+
yarn install --force
13+
14+
# Bump versions for changed packages
15+
yarn lerna version --conventional-graduate
16+
17+
# Push and create a release PR
18+
git push
19+
open https://github.com/endojs/Jessie/pulls
20+
```
21+
22+
Get approval and wait for CI to pass.
23+
24+
```sh
25+
# Build release artifacts.
26+
yarn build
27+
28+
# Publish to NPM. NOTE: You may have to repeat this several times if there are failures.
29+
# without concurrency until https://github.com/Agoric/agoric-sdk/issues/8091
30+
yarn lerna publish --concurrency 1 from-package
31+
```
32+
33+
Merge the release PR into the base branch.
34+
35+
**DO NOT REBASE OR SQUASH OR YOU WILL LOSE REFERENCES TO YOUR TAGS.**
36+
37+
You may use the GitHub "Merge" button directly instead of automerge.

0 commit comments

Comments
 (0)