From c9550f4e6b9adbcedcac6ce7fcfcbd685b5d102d Mon Sep 17 00:00:00 2001 From: Marcus Date: Fri, 22 Nov 2024 12:59:57 -0800 Subject: [PATCH 1/3] Create Release-XKit.md --- docs/contributing/Release-XKit.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/contributing/Release-XKit.md diff --git a/docs/contributing/Release-XKit.md b/docs/contributing/Release-XKit.md new file mode 100644 index 000000000..3e312aca0 --- /dev/null +++ b/docs/contributing/Release-XKit.md @@ -0,0 +1,13 @@ +## 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). +- Commit a version increase to [xkit_patches.js](../../Extensions/xkit_patches.js). + - `run_order` should have an additional entry added with the new version. + - `patches` should have an additional entry added, corresponding with the new version. In most cases, this should consist of a) changing the key of the latest entry to the new version, and b) adding a new empty entry below it corresponding to the current version. This represents setting the entire current set of patches to apply to both the current and new versions. +- 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. +- Merge the resulting PR. From e0755f34b83e050869dbae7af96024c6eddc965c Mon Sep 17 00:00:00 2001 From: Marcus Date: Sun, 1 Dec 2024 17:40:09 -0800 Subject: [PATCH 2/3] remove XKit Patches version bump requirement see #2165, #2166 --- docs/contributing/Release-XKit.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/contributing/Release-XKit.md b/docs/contributing/Release-XKit.md index 3e312aca0..e5d75ca8c 100644 --- a/docs/contributing/Release-XKit.md +++ b/docs/contributing/Release-XKit.md @@ -3,9 +3,6 @@ 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). -- Commit a version increase to [xkit_patches.js](../../Extensions/xkit_patches.js). - - `run_order` should have an additional entry added with the new version. - - `patches` should have an additional entry added, corresponding with the new version. In most cases, this should consist of a) changing the key of the latest entry to the new version, and b) adding a new empty entry below it corresponding to the current version. This represents setting the entire current set of patches to apply to both the current and new versions. - 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. From a4f24934314e9b772a26c91ced99648720c80e63 Mon Sep 17 00:00:00 2001 From: Marcus Date: Mon, 2 Dec 2024 00:09:12 -0800 Subject: [PATCH 3/3] document disabled in-extension update notifications --- .github/workflows/update-release-metadata.yml | 2 +- docs/contributing/Release-XKit.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 index e5d75ca8c..c2dc4b4e4 100644 --- a/docs/contributing/Release-XKit.md +++ b/docs/contributing/Release-XKit.md @@ -6,5 +6,5 @@ Manually building, submitting, and deploying an XKit version release currently t - 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. +- 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.