Skip to content
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

Jump to bottom

For #65: Update Relase Docs #84

Merged
merged 2 commits into from
Nov 15, 2021
Merged

For #65: Update Relase Docs #84

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0504112
For #65: Update Relase Docs
matt-boris Nov 11, 2021
436dcf8
Add signed binary download instructions
matt-boris Nov 15, 2021
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
44 changes: 38 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,41 @@ npx web-ext run --verbose --firefox-binary /path/to/nightly/firefox -s extension

# Release

1. Bump version in ``package.json``, ``update.json``, and ``extension/manifest.json``
2. Tag commit ``git tag -a X.Y.Z`` and push it
3. Create release with changelog on Github
4. Check that ``FirefoxCI`` action has run for tagged commit
5. Request sign-off on Slack channel ``#addons-pipeline``
6. Download signed build from Task Cluster, and attach ``remote-settings-devtools-X.Y.Z.xpi`` binary file on Github release page
### Prerequisites (get access to Ship-It)

1. Create a ticket to be added to the VPN group (can clone and edit [this Bugzilla ticket](https://bugzilla.mozilla.org/show_bug.cgi?id=1740098))
2. Ask in the [#addons-pipeline](https://mozilla.slack.com/archives/CMKP7NPKN) channel to be added to the `XPI_PRIVILEGED_BUILD_GROUP` to get access to create an XPI release for `remote-settings-devtools` on [Ship-It](https://shipit.mozilla-releng.net/)

### Create a new tag/release

1. Bump version in `package.json`, `update.json` (has **three** version instances that need to be updated), and `extension/manifest.json`
2. Tag commit `git tag -a X.Y.Z` and push it `git push origin X.Y.Z`
Comment on lines +53 to +54
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it would be worth abstracting this into a little convenience script so that instead of having to remember to update in 5 places, tag, then push, we run like scripts/generate_release.sh or something that. Not necessary for this PR, but if we find ourselves forgetting to update these values, maybe something we consider.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I like that! Just created #85

3. Create release with changelog on [GitHub's releases page](https://github.com/mozilla-extensions/remote-settings-devtools/releases/new)
4. Check that `FirefoxCI` action has run for tagged commit

### Create release on Ship-It

1. Ensure you're connected to the VPN
2. Go to [Ship-It](https://shipit.mozilla-releng.net/)
3. Login with SSO at the top right
4. Click `NEW XPI RELEASE` at the top and select the following options:
- `Available XPIs` → `remote-settings-devtools`
- `Available revisions` → revision with the commit hash associated with the tag that's being released
5. Ensure the version that was tagged is the one shown
6. Select `CREATE RELEASE` → `SUBMIT`
7. Scroll to the bottom of the [pending releases page](https://shipit.mozilla-releng.net/xpi)
8. Click `Build` on the new release labeled `remote-settings-devtools-X.Y.Z-build1`
9. Go to [#addons-pipeline](https://mozilla.slack.com/archives/CMKP7NPKN) and request sign off:
> Hi! There's a new version of the remote-settings-devtools extension, remote-settings-devtools-X.Y.Z, ready for sign off. It does THIS AND THAT. Thank you!

### Download signed binary from Taskcluster

1. Go to [XPI Releases](https://shipit.mozilla-releng.net/xpi)
2. Click on `Promote task` on the XPI release you want to download the signed binary from, which will take you to Taskcluster
3. Click on the `release-signing-remote-settings-devtools` task
4. Click the `Artifacts` dropdown on the right side of the page
5. Download the artifact named `public/build/remote-settings-devtools.xpi` to your machine
6. Append `-X.Y.Z` to the end of the filename
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why the artifact is not named with the release name (remote-settings-devtools-X.Y.Z-build1)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was confused by this too... Wonder if it's worth bringing up to #addons-pipeline

7. Attach `remote-settings-devtools-X.Y.Z.xpi` signed binary file to the corresponding GitHub release

Additional information may be found [here](https://github.com/mozilla-extensions/xpi-manifest/blob/master/docs/releasing-a-xpi.md#kicking-off-the-release).