mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-23 10:30:04 +01:00
57 lines
3.2 KiB
Markdown
57 lines
3.2 KiB
Markdown
# Publishing Guide
|
|
|
|
When publishing a new version of MetaMask, we follow this procedure:
|
|
|
|
## Overview
|
|
|
|
The below diagram outlines our process for design, development, and release. Building MetaMask is a community affair, and many steps of the process invite participation from external contributors as indicated. All QA, code review, and release of new versions is done by members of the core MetaMask team.
|
|
|
|
<img width="664" alt="mm-dev-process" src="https://user-images.githubusercontent.com/1016190/56308059-36906000-60fb-11e9-8e61-6655bca0c54f.png">
|
|
|
|
|
|
## Preparation
|
|
|
|
We try to ensure certain criteria are met before deploying:
|
|
|
|
- Deploy early in the week, to give time for emergency responses to unforeseen bugs.
|
|
- Deploy early in the day, for the same reason.
|
|
- Make sure at least one member of the support team is "on duty" to watch for new user issues coming through the support system.
|
|
- Roll out incrementally when possible, to a small number of users first, and gradually to more users.
|
|
|
|
## Incrementing Version & Changelog
|
|
|
|
Version can be automatically incremented by creating a branch with the name `Version-vX.Y.Z`, where `X`, `Y`, and `Z` are numbers. Branches should be created off of the main branch. [Branches can be created on GitHub.](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository)
|
|
|
|
Once a version branch has been created, a build on CircleCI will create a Pull Request for the release with the app manifest and changelog versions bumped.
|
|
|
|
## Preparing for Sensitive Changes
|
|
|
|
In the case that a new release has sensitive changes that cannot be fully verified prior to publication, please follow the [sensitive release protocol](./sensitive-release.md).
|
|
|
|
## Building
|
|
|
|
While we develop on the main `develop` branch, our production version is maintained on the `master` branch.
|
|
|
|
With each pull request, the @MetaMaskBot will comment with a build of that new pull request, so after bumping the version on `develop`, open a pull request against `master`, and once the pull request is reviewed and merged, you can download those builds for publication.
|
|
|
|
## Publishing
|
|
|
|
1. Publish to chrome store.
|
|
2. Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2).
|
|
3. Publish to [firefox addon marketplace](http://addons.mozilla.org/en-us/firefox/addon/ether-metamask).
|
|
4. Publish to [Opera store](https://addons.opera.com/en/extensions/details/metamask/).
|
|
5. Post on [Github releases](https://github.com/MetaMask/metamask-extension/releases) page.
|
|
6. Run the `yarn announce` script, and post that announcement in our public places.
|
|
|
|
## Hotfix Differences
|
|
|
|
Our `develop` branch is usually not yet fully tested for quality assurance, and so should be treated as if it is in an unstable state.
|
|
|
|
For this reason, when an urgent change is needed in production, its pull request should:
|
|
|
|
- Describe it as a hotfix.
|
|
- Use a hotfix tag.
|
|
- Should be proposed against the `master` branch.
|
|
|
|
The version and changelog bump should then be made off the `master` branch, and then merged to `develop` to bring the two branches back into sync. Further time can be saved by incorporating the version/changelog bump into the PR against `master`, since we rely on @MetaMaskBot to run tests before merging.
|