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.

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

[ext] build separate packages for Firefox and Chrome (manifest v3) #1982

Merged
merged 4 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 11 additions & 8 deletions .github/workflows/browser-extension-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v2
fetch-tags: true

- uses: actions/setup-node@v4
with:
node-version: '18'

Expand All @@ -40,7 +41,8 @@ jobs:
- name: Build browser extension
if: ${{ env.tag_exist == 0 }}
run: |
./build.sh
EXTENSION_BROWSER=firefox MANIFEST_VERSION=2 ./build.sh -o tournesol_extension_firefox.zip
EXTENSION_BROWSER=chrome MANIFEST_VERSION=3 ./build.sh -o tournesol_extension_chrome.zip

- name: Error message
if: failure()
Expand All @@ -51,11 +53,11 @@ jobs:
More detail: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"}'
${{ secrets.DISCORD_BROWSER_EXTENSION_WEBHOOK_URL }}

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
if: ${{ env.tag_exist == 0 }}
with:
name: browser-extension-zipfile
path: browser-extension/tournesol_extension.zip
name: browser-extension-zipfiles
path: browser-extension/tournesol_extension*.zip

- name: Send zip file on Discord
if: ${{ env.tag_exist == 0 }}
Expand All @@ -64,5 +66,6 @@ jobs:
-F 'payload_json={"username": "ExtensionBot",
"content": "The browser extension version **${{ env.ext_version }}** has been built.\n
More detail: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"}'
-F "file1=@tournesol_extension.zip"
-F "files[0]=@tournesol_extension_firefox.zip"
-F "files[1]=@tournesol_extension_chrome.zip"
${{ secrets.DISCORD_BROWSER_EXTENSION_WEBHOOK_URL }}
14 changes: 7 additions & 7 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ jobs:
e2e-browser-extension:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: '18'

- name: Prepare extension
working-directory: browser-extension
run: |
node prepareExtension.js
EXTENSION_BROWSER=chrome MANIFEST_VERSION=3 yarn configure

- uses: cypress-io/github-action@v5
- uses: cypress-io/github-action@v6
with:
working-directory: tests
browser: chrome
Expand All @@ -40,18 +40,18 @@ jobs:
e2e-frontend:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Start dev env
run: ./dev-env/run-docker-compose.sh
env:
FRONTEND_START_SCRIPT: "start:e2e"

- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: '18'

- uses: cypress-io/github-action@v5
- uses: cypress-io/github-action@v6
with:
working-directory: tests
browser: chrome
Expand Down
19 changes: 15 additions & 4 deletions browser-extension/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,31 @@

set -eu

usage() { echo "Usage: $0 [-o tournesol_extension.zip]" 1>&2 ; }

SCRIPT_PATH="$(realpath -e "$(dirname "$0")")"
SOURCE_DIR='src'
TARGET_BASENAME='tournesol_extension.zip'
OUTPUT_FILE='tournesol_extension.zip'

while getopts "ho:" opt; do
case $opt in
o ) OUTPUT_FILE=$OPTARG;;
h ) usage
exit 0;;
*) usage
exit 1;;
esac
done

pushd ${SCRIPT_PATH} > /dev/null
pushd "${SCRIPT_PATH}" > /dev/null

node prepareExtension.js

# zip the sources
pushd ${SOURCE_DIR} > /dev/null
zip -r -FS ../${TARGET_BASENAME} *
zip -r -FS ../"${OUTPUT_FILE}" ./*
popd > /dev/null

# zip the license
zip ${TARGET_BASENAME} LICENSE
zip "${OUTPUT_FILE}" LICENSE
popd > /dev/null
2 changes: 1 addition & 1 deletion browser-extension/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "tournesol-extension",
"version": "3.5.3",
"version": "3.6.0",
"license": "AGPL-3.0-or-later",
"type": "module",
"scripts": {
Expand Down
7 changes: 4 additions & 3 deletions browser-extension/prepareExtension.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,10 @@ const permissions = [
// with version > 3.5.2.
// These permissions can be removed as soon as we are confident
// the next release works as expected.
'webRequest',
'webRequestBlocking',
...selectValue(manifestVersion, { 2: [], 3: ['scripting'] }),
...selectValue(manifestVersion, {
2: ['webRequest', 'webRequestBlocking'],
3: ['scripting'],
}),
];

const allPermissions = selectValue(manifestVersion, {
Expand Down
Loading