Skip to content

Update README with publishing instructions #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 2, 2020
Merged

Update README with publishing instructions #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c98e641
Update README with publishing instructions
whymarrh Sep 2, 2020
1fa4419
Merge branch 'master' into publishing-instr
whymarrh Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,18 @@ ee.emit('boom'); // No error here

// Error is thrown after setTimeout
```

### Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization:

1. Create a release branch
- For a typical release, this would be based on `master`
- To update an older maintained major version, base the release branch on the major version branch (e.g. `1.x`)
2. Update the changelog
3. Update version in package.json file (e.g. `yarn version --minor --no-git-tag-version`)
4. Create a pull request targeting the base branch (e.g. master or 1.x)
5. Code review and QA
6. Once approved, the PR is squashed & merged
7. The commit on the base branch is tagged
8. The tag can be published as needed