-
Notifications
You must be signed in to change notification settings - Fork 324
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add release process and move to ./docs (#1113)
Co-authored-by: Marcin Rataj <[email protected]>
- Loading branch information
Showing
5 changed files
with
120 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Release Process | ||
| --- | ||
|
|
||
| This process can be used to push a manual release to the [Firefox Add-Ons](https://addons.mozilla.org/) and [Chrome Web Store](https://chrome.google.com/webstore/category/extensions). Before you can do that you need to: | ||
|
|
||
| - [Release Process](#release-process) | ||
| - [Tag a Release](#tag-a-release) | ||
| - [Build Release Artifacts](#build-release-artifacts) | ||
| - [Publish on Chrome Web Store)](#publish-on-chrome-web-store) | ||
| - [Publish on Firefox Add-Ons Store](#publish-on-firefox-add-ons-store) | ||
| - [Release on Github.](#release-on-github) | ||
|
|
||
|
|
||
| ## Tag a Release | ||
|
|
||
| - Bump `<semver>` version in `add-on/manifest.common.json` | ||
| - Create a PR for Release | ||
| - Generate and push the tag to github | ||
| ```sh | ||
| git tag v<semver> && git push && git push origin v<semver> # Don't forget the 'v' prefix | ||
| ``` | ||
| - Create draft release from https://github.com/ipfs/ipfs-companion/releases using the `v<semver>` tag | ||
| - Use github's auto release notes feature to fill release notes. | ||
| ## Build Release Artifacts | ||
| - run `npm run release-build` | ||
| - `build` folder would contain three artifacts, one each for: | ||
| - brave | ||
| - chromium | ||
| - firefox | ||
| - Attach these assets to the draft release. | ||
| ## Publish on Chrome Web Store | ||
| All Chromium-based browsers support install from Chrome Web Store. | ||
| Brave, Opera, and Edge do not require additional publishing step. | ||
| - IPFS Companion Chrome Webstore: https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch | ||
| - Publishing requires your Google Account to belong to the IPFS Companion Maintainers Google Group (ask IPFS Stewards to be added). | ||
| - Go to Developer Dashboard and select publisher: `IPFS Shipyard`. | ||
| - Select `Package` from the left sub-menu. | ||
| - Upload the newly built package for Chromium [earlier](#build-release-artifacts). | ||
| - The new package goes to draft state automatically. | ||
| - Go to `Store listing` section from the left sub-menu. | ||
| - Click `Save Draft` and then `Submit for Review`. | ||
| - "Review" may take from a few hours to a few days. Google sends no email informing when new version is approved. | ||
| - Only way to check it is to inspect the version number on the store listing or Dev Dashboard. | ||
| ## Publish on [Firefox Add-Ons Store](https://addons.mozilla.org/) | ||
| - IPFS Companion Firefox Add-On: https://addons.mozilla.org/en-US/firefox/addon/ipfs-companion/ | ||
| - Publishing requires logging into a [Developer Account](https://addons.mozilla.org/developers/) at Firefox Add-Ons site. The account needs to be marked as one of developers of IPFS Companion (ask IPFS Stewards to be added). | ||
| - Goto `Manage My Submissions` from the drop-down menu from your username. | ||
| - Select `IPFS Companion` item. | ||
| - On the left menu select `Manage Status & Versions` | ||
| - Open the latest one in a new tab because you'll need this for reference for copying listing details. | ||
| - Click `Upload a New Version`. | ||
| - Select the Firefox-specific asset generated [earlier](#build-release-artifacts). | ||
| - For `Compatibility` select both : | ||
| - Firefox | ||
| - Firefox for Android | ||
| - Optionally quickly check the validation report to see there are no blocking validations. | ||
| - Click continue. | ||
| - When asked: `Do you need to submit source code` select `yes` | ||
| - Go to Github Release and download .zip with Source Code for the release tag. | ||
| - Upload it to Mozilla. | ||
| - In the field asking for release notes just link to the release at Github | ||
| - Add Instructions/Notes for the reviewer (*Warning: if you forget, the release may be rejected during human review*): | ||
| - Reuse the explanation from the previous release (ask reviewer to run the `npm run release-build` so they can run the build in a Docker container and get reproducible result across platforms) | ||
| - The new build is published immediately, but it will be reviewed in a week by a real human (unlike Chrome Web Store), and can be taken down if it doesn’t meet the guidelines around privacy and reproducibility. | ||
|
|
||
| ## Release on Github. | ||
|
|
||
| Release the draft release just created. That's it! |