build: Fix and improve builds for Mozilla Firefox requirements (#127)

Should help to resolve
codecov/engineering-team#3536 and #124 once a
new release is cut.

Author: ElioDiNino

.github/workflows/ci.yml

@@ -9,10 +9,12 @@ jobs:
   ci:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: "22"
       - run: npm ci
-      - name: Build extension
+      - name: Build Chrome extension
         run: npm run build
+      - name: Build Firefox extension
+        run: npm run build:firefox

.github/workflows/publish.yml

@@ -11,33 +11,48 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: "22"
+      - name: Create local git tag
+        # This is necessary to ensure that the tag exists within the
+        # source archive and can be read by our set-version script.
+        run: |
+          git tag "${{ github.event.release.tag_name }}"
       - name: Generate source archive
         run: npm run archive
       - name: Install dependencies
         run: npm ci
       - name: Build extension
         run: npm run build
         env:
-          SENTRY_DSN: ${{ vars.SENTRY_DSN }}
           SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
-      - run: |
-          jq --arg version "$VERSION" '.version=$version' dist/manifest.json > manifest.tmp.json \
-            && mv manifest.tmp.json dist/manifest.json
-          jq --arg version "$VERSION" '.version=$version' dist/manifest.firefox.json > manifest.tmp.json \
-            && mv manifest.tmp.json dist/manifest.firefox.json
-        env:
           VERSION: ${{ github.event.release.tag_name }}
-      - run: |
-          cp -r dist dist-firefox
-          mv dist-firefox/manifest.firefox.json dist-firefox/manifest.json
-          mv codecov-browser-extension.tar.gz dist-firefox
+      - name: Prepare Firefox extension
+        run: |
+          cp -r dist dist-chrome
+          mv dist/manifest.firefox.json dist/manifest.json
+          npm run set-version
+          mv dist dist-firefox
+      - name: Upload built Chrome extension
+        uses: actions/upload-artifact@v4
+        with:
+          name: codecov-chrome-${{ github.event.release.tag_name }}
+          path: ./dist-chrome/
+      - name: Upload built Firefox extension
+        uses: actions/upload-artifact@v4
+        with:
+          name: codecov-firefox-${{ github.event.release.tag_name }}
+          path: ./dist-firefox/
+      - name: Upload source archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: codecov-browser-extension.tar.gz
+          path: codecov-browser-extension.tar.gz
       - name: Publish to Chrome
-        working-directory: dist
-        run: npx chrome-webstore-upload-cli@2 upload --auto-publish
+        working-directory: dist-chrome
+        run: npx chrome-webstore-upload-cli@3
         env:
           EXTENSION_ID: "gedikamndpbemklijjkncpnolildpbgo"
           CLIENT_ID: ${{ secrets.GOOGLE_WEB_STORE_CLIENT_ID }}
@@ -50,4 +65,5 @@ jobs:
           WEB_EXT_API_KEY: ${{ secrets.WEB_EXT_JWT_ISSUER }}
           WEB_EXT_API_SECRET: ${{ secrets.WEB_EXT_JWT_SECRET }}
           WEB_EXT_CHANNEL: listed
-          WEB_EXT_API_UPLOAD_SOURCE_CODE: codecov-browser-extension.tar.gz
+          WEB_EXT_API_UPLOAD_SOURCE_CODE: ../codecov-browser-extension.tar.gz
+          WEB_EXT_APPROVAL_TIMEOUT: 0 # Disable timeout for approval

.gitignore

@@ -4,3 +4,4 @@ dist/
 tmp/
 .vscode/
 codecov-browser-extension.tar.gz
+.DS_Store

README.md

@@ -26,15 +26,15 @@ If you wish to simply use the extension, it is available as a [Firefox Add On](h
 
 The Codecov browser extension makes it easy to identify needed test areas by showing you absolute coverage and coverage changes overlaid with your code right in GitHub.
 
-Once installed, get:
+Once installed, you get:
 
 - Line coverage information while viewing commits and single files
 - Line coverage information and coverage totals on Pull Requests
 - The ability to filter coverage using Flags and Components directly in the GitHub UI
 
 Pre-requisites:
 
-- Must use either Firefox or Google Chrome web browsers.
+- Must use either the Firefox or Google Chrome web browser.
 
 How to enable:
 
@@ -67,7 +67,11 @@ You can provide this information by using the Settings menu for the Extension in
 ## Running Locally
 
 ```sh
-$ web-ext run -s dist -t chromium
+$ npm install
+# For Chrome
+$ npm run start:chrome
+# For Firefox
+$ npm run start:firefox
 ```
 
 **Note**: You must be on GitHub's new UI for this extension to perform its magic. ✨
@@ -80,21 +84,31 @@ As of today, GitHub will show you the old UI if not logged in (running in a temp
 
 These steps will build the extension in the `dist/` folder.
 
-Node 22 and npm 10
+### Prerequisites
+
+Node 22, `npm` 10, and `git` are required to build the extension.
+
+### Set Local Version
+
+To override the local version of the extension, you can set the `VERSION` environment variable before building. This is useful for testing or development purposes.
 
-Chrome
+E.g.
+```sh
+$ export VERSION=1.0.0
+```
+
+### Chrome
 
 ```sh
 $ npm install
 $ npm run build
 ```
 
-Firefox
+### Firefox
 
 ```sh
 $ npm install
-$ npm run build
-$ mv dist/manifest.firefox.json dist/manifest.json
+$ npm run build:firefox
 ```
 
 ## About Codecov