Skip to content

Commit

Permalink
Update publishing instructions
Browse files Browse the repository at this point in the history
The publishing instructions in the README have been updated to reflect
changes introduced in #31. We forgot to update the README in that PR.

The release instructions should now match those in the module template.
  • Loading branch information
Gudahtt committed Nov 9, 2022
1 parent bd958e0 commit dee6f31
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,6 @@ The project follows the same release process as the other libraries in the MetaM

7. Publish the release on npm.

- Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
- Use `npm publish --dry-run` to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using `https://unpkg.com/browse/[package name]@[package version]/`).
- Once you are confident the release contents are correct, publish the release using `npm publish`.
- Wait for the `publish-release` GitHub Action workflow to finish. This should trigger a second job (`publish-npm`), which will wait for a run approval by the [`npm publishers`](https://github.com/orgs/MetaMask/teams/npm-publishers) team.
- Approve the `publish-npm` job (or ask somebody on the npm publishers team to approve it for you).
- Once the `publish-npm` job has finished, check npm to verify that it has been published.

0 comments on commit dee6f31

Please sign in to comment.