Skip to content

Commit

Permalink
Latest updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanio committed Apr 29, 2020
1 parent 382e531 commit e9617e8
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The following describes the steps required to release a new version of `web3.js`
1. Ensure CI is green / passing.
1. (spend time here inspecting the CI logs to ensure everything looks valid and results were reported correctly)
1. Run `npm run publish from-package -- --dist-tag rc`.
1. Lerna can sometimes have difficulty with the number of packages we have. If the above command is unsuccessful, then check every package and run the following command once for every package that is missing its tags: `TODO add individual lerna publish cmd here` `npm dist-tag add <package-name>@<version> rc`)
1. Lerna can sometimes have difficulty with the number of packages we have. If the above command is unsuccessful, for every unpublished package run: `lerna publish --scope="package-name"` `npm dist-tag add <package-name>@<version> rc`)
1. Publish the GitHub release.
1. A GitHub Webhook should trigger the ReadTheDocs build after the release is published.
1. (The build may sometimes need to be manually triggered in ReadTheDocs admin panel. If the version does not appear, create a build of a previous version to refresh the list.)
Expand All @@ -106,12 +106,15 @@ The following describes the steps required to release a new version of `web3.js`

1. Create GitHub draft release from text of `rc` release.
1. Checkout release branch (e.g. `release/1.2.7`).
1. Create and push release commit and tags: `lerna version 1.2.7`
1. Create and push release commit and tags: `lerna version 1.2.7 --force-publish --no-push`
1. Check git working state is clean. Sometimes files modified by gulp are not included. If so, run `git commit --amend` and `git tag -d 1.2.7` and `git tag 1.2.7`.
1. Push release branch to origin with tags `git push origin release/1.2.7 --follow-tags`.
1. Publish the GitHub release.
1. A GitHub Webhook should trigger the ReadTheDocs build after the release is published.
1. (The build may sometimes need to be manually triggered in ReadTheDocs admin panel. If the version does not appear, create a build of a previous version to refresh the list.)
1. Activate the new version.
1. Set the version to default.
1. Run `npm run publish from-package`.
1. Merge release PR.
1. Share the release announcement on:
1. (_Note:_ There is a delay on npm between different regions, so all may not see the release immediately.)
Expand All @@ -124,5 +127,4 @@ The following describes the steps required to release a new version of `web3.js`
1. Santiago from OpenZeppelin ([@spalladino](https://github.com/spalladino))
1. Pedro from WalletConnect ([@pedrouid](https://github.com/pedrouid))
1. Josh from FunFair ([@joshstevens19](https://github.com/joshstevens19))
1. Truffle, Gnosis, Aragon, Embark, Alchemy
1. EF projects: Buidler, Remix, Play, Grid
1. Truffle, Gnosis, Aragon, Embark, Alchemy, Buidler, Remix

0 comments on commit e9617e8

Please sign in to comment.