From 8ce5b5bf7786fbaa31174173919d76901e1f233c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?So=CC=88ren=20Schro=CC=88der?= Date: Sat, 9 Apr 2022 14:09:01 +0200 Subject: [PATCH] Add release process documentation --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index cb34318..836af93 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,21 @@ Download it from the [Chrome Web Store](https://chrome.google.com/webstore/detai * ![grafik](https://user-images.githubusercontent.com/5639787/117260720-5d727980-ae1d-11eb-95ba-7f417ee33a45.png) 4. Click ‘Load unpacked’ 5. Select the previously extracted folder (not one of the files inside the folder but the whole folder) + + +## Release instructions +### Preperations +1. Update the version in the **manifest.json** according to [semantic versioning](https://semver.org). + +### Chrome +1. Create a zip file that contains all repositories content. The root level of the zip file must mirror the root level of the repository. +2. Upload the zip to the [Chrome Web Store Developer Console](https://chrome.google.com/u/1/webstore/devconsole) + +### Firefox +1. If not already done install the [web-ext](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign) command line tool. +2. Set the value of "manifest_version" in **manifest.json** to 2, to maintain be compatible to Firefox (discard the change before checking in the code. +3. Make a test run by execute `web-ext run` at the project's root level. +4. Run `web-ext sign --api-key=$AMO_JWT_ISSUER --api-secret=$AMO_JWT_SECRET id=$WEB_EXT_ID` at the project's root level to create a signed package. Replace `$AMO_JWT_ISSUER` and `$AMO_JWT_SECRET` with the [Mozilla Api-Key](https://addons.mozilla.org/en-US/developers/addon/api/key/) values. Furthermore, replace `$WEB_EXT_ID` by the [plugins UUID](https://addons.mozilla.org/en-US/developers/addons) (with curly-brackets). +5. Upload the resulting file to a new release in GitHub +6. Enter the location of the new version into the `update.json` file +7. Commit and push the `update.json` file