diff --git a/.github/workflows/update-release-metadata.yml b/.github/workflows/update-release-metadata.yml index a8131eb5c..dc02b0f5e 100644 --- a/.github/workflows/update-release-metadata.yml +++ b/.github/workflows/update-release-metadata.yml @@ -32,6 +32,6 @@ jobs: commit-message: update release metadata branch: update-release-metadata body: | - Updates the extension version in metadata files, triggering Firefox autoupdate and the "Please update XKit!" in-extension notification. + Updates the extension version in metadata files, triggering Firefox autoupdate and the "Please update XKit!" in-extension notification (currently disabled). Remember to confirm that the referenced version is released on Github, the .xpi file link works, and the Chrome web store has the referenced version available before merging this. diff --git a/docs/contributing/Release-XKit.md b/docs/contributing/Release-XKit.md new file mode 100644 index 000000000..c2dc4b4e4 --- /dev/null +++ b/docs/contributing/Release-XKit.md @@ -0,0 +1,10 @@ +## XKit release checklist + +Manually building, submitting, and deploying an XKit version release currently takes many steps, but there is some Github Actions automation to combine some of them and allow them to be run from the web interface. + +- Commit a version increase to [manifest.json](../../manifest.json). +- Run the **Generate Release** Github action. This will package the extension code and submit it to the Firefox addons store and Chrome web store for security review and signing, and generate a Github release draft if they succeed. + - If Firefox review and signing causes the action to time out, wait for it to finish, then run the **Generate Release (after signing)** Github action. +- Edit the Github release draft to add release notes and any additional information. +- When ready, publish the Github release and run the **Publish Release** action. This will publish the new version for automatic update on the Chrome web store, and will create a pull request to update the repository metadata that triggers automatic update in Firefox and in-extension update notifications (currently disabled; see #2171). +- Merge the resulting PR.