Release and Publish for Browser Extension

.github/workflows/deploy.yml

@@ -3,15 +3,15 @@ name: Deploy Browser Extension
 on:
   workflow_dispatch:
     inputs:
-        browser:
-            description: Browser platform to build for as an array (e.g., '["chrome"]", '["firefox", "chrome"]')
-            required: false
-            default: '["chrome", "firefox"]'
-            type: string
-        tag:
-            description: Tag to deploy (e.g., "ecu-test-diff-1.0.0")
-            required: true
-            type: string
+      browser:
+        description: Browser platform to build for as an array (e.g., '["chrome"]", '["firefox", "chrome"]')
+        required: false
+        default: '["chrome", "firefox"]'
+        type: string
+      tag:
+        description: Tag to deploy (e.g., "ecu-test-diff-1.0.0")
+        required: true
+        type: string
   push:
     tags:
       - 'ecu-test-diff-[0-9]+.[0-9]+.[0-9]+'
@@ -20,7 +20,7 @@ jobs:
   setup:
     runs-on: ubuntu-latest
     outputs:
-        tag-version: ${{ steps.set-tag.outputs.tag-version }}
+      tag-version: ${{ steps.set-tag.outputs.tag-version }}
     steps:
       - name: Set tag
         id: set-tag
@@ -55,7 +55,14 @@ jobs:
           MANIFEST_VERSION=$(jq -r '.version' static/manifest.json)
           echo "Tag version: $TAG_VERSION"
           echo "Manifest version: $MANIFEST_VERSION"
-
+
+          # check for beta versions first
+          if [[ "$MANIFEST_VERSION" == *-beta* ]]; then
+            echo "❌ Release workflow is not supported for beta versions. Manifest version ($MANIFEST_VERSION) is not ready for publishing."
+            echo "proceed=false" >> $GITHUB_OUTPUT
+            exit 1
+          fi
+
           # extract the version from the tag
           TAG_VERSION=${TAG_VERSION#ecu-test-diff-}
           if [ "$TAG_VERSION" != "$MANIFEST_VERSION" ]; then

README.md

@@ -1,14 +1,19 @@
 # ecu.test Diff Extension <!-- omit in toc -->
 
+![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/dpplpkgobhppfnfnfkpinlhognmaphnl?style=flat&logo=googlechrome&logoColor=%23FFFF&logoSize=auto&color=%234285F4&link=https%3A%2F%2Fchromewebstore.google.com%2Fdetail%2Fopen-with-ecutest-diff%2Fdpplpkgobhppfnfnfkpinlhognmaphnl)
+![Mozilla Add-on Version](https://img.shields.io/amo/v/open-with-ecu-test-diff?style=flat&logo=firefoxbrowser&logoColor=%23FFFF&logoSize=auto&color=%23FF7139&link=https%3A%2F%2Faddons.mozilla.org%2Fen-US%2Ffirefox%2Faddon%2Fopen-with-ecu-test-diff%2F)
+[![REUSE Compliance Check](https://github.com/tracetronic/ecu.test-diff/actions/workflows/reuse.yml/badge.svg)](https://github.com/tracetronic/ecu.test-diff/actions/workflows/reuse.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/tracetronic/ecu.test-diff/blob/main/LICENSE)
+
 - [Description](#description)
 - [Features](#features)
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Usage](#usage)
-  - [Documentation](#documentation)
-  - [Contribution](#contribution)
-  - [Support](#support)
-  - [Licensing](#licensing)
+- [Documentation](#documentation)
+- [Contribution](#contribution)
+- [Support](#support)
+- [Licensing](#licensing)
 
 ## Description
 
@@ -67,51 +72,58 @@ You are good to go! You can also pin the extension to the toolbar for easy acces
 - Select the correct platform type and add the host
 - Go to the options e.g., via click on the cog-wheel icon
 - Now enter your API token
+
   - ⚠️Don\'t give the token all permissions, use fine-grained tokens ⚠️
   - Only reading repository commits and pull requests and API access
-  <details>
-
-    <summary >How to create an API token with <b>required minimal access</b></summary>
-
-    - GitHub
-      1. Go to your profile settings
-      2. Go to `Developer Settings`
-      3. Select `Personal access tokens` - `Fine-grained tokens`
-      4. Select `Generate new token`
-      5. Set `Repository access` as desired. If you give access to non-public repositories, make sure to grant `Repository permissions` for `Content` (read-only) and `Pull requests` (read-only)
-    - GitLab
-      1. Go to `Settings` - `Access tokens` in the relevant group or repository
-      2. Select `Add new token`
-      3. Set **Scope** to `read_api`, select a **Role** that is allowed to access code and changes
+    <details>
+      <summary >
+        How to create an API token with <b>required minimal access</b>
+      </summary>
+
+      - GitHub
+        1. Go to your profile settings
+        2. Go to `Developer Settings`
+        3. Select `Personal access tokens` - `Fine-grained tokens`
+        4. Select `Generate new token`
+        5. Set `Repository access` as desired. If you give access to non-public repositories, make sure to grant `Repository permissions` for `Content` (read-only) and `Pull requests` (read-only)
+      - GitLab 1. Go to `Settings` - `Access tokens` in the relevant group or repository 2. Select `Add new token` 3. Set **Scope** to `read_api`, select a **Role** that is allowed to access code and changes
     </details>
-
-<img src="./docs/images/firefox/configuration.png" alt="Configuration" width="800"/>
+    <img style="display: block; alight: left" src="./docs/images/firefox/configuration.png" alt="Configuration" width="800"/>
 
 - Save the settings
 - Go back to the commit page and open the popup again
 - The supported files of the changes will be listed
+- Files that cannot be diffed with the ecu.test Diff-Viewer can still be opened individually for both the old and new versions
+- Click on a file and click on "Show new" or "Show old"
 
-<img src="./docs/images/firefox/dialog.png" alt="Configuration" width="600"/>
+  <img style="display: block; alight: left" src="./docs/images/firefox/dialog_download.png" alt="Configuration Download" width="600"/>
 
+- Files supported by the ecu.test Diff-Viewer will open directly in the viewer
 - Click on a file and click on "Show diff"
+
+  <img style="display: block; alight: left" src="./docs/images/firefox/dialog.png" alt="Configuration" width="600"/>
+
 - ecu.test Diff-Viewer will be opened
-  - ⚠️This needs ecu.test installed and a valid license available⚠️
 
-### Documentation
+  - ⚠️This needs ecu.test installed and a valid license available ⚠️
+
+    <img style="display: block; alight: left" src="./docs/images/firefox/diff_viewer.png" alt="Diff Viewer" width="800"/>
+
+## Documentation
 
 For detailed documentation on features, build and development setup, see the [DeveloperGuide](./docs/DeveloperGuide.md).
 
-### Contribution
+## Contribution
 
 At the moment, no external contributions are intended and merge requests from forks will automatically be rejected!
 To report a bug or request an enhancement to this extension,
 please raise a new [GitHub issue](https://github.com/tracetronic/ecu.test-diff/issues).
 
-### Support
+## Support
 
 If you have any further questions, please contact us at [support@tracetronic.com](mailto:support@tracetronic.com).
 
-### Licensing
+## Licensing
 
 This work is licensed under MIT license. This project is based on the boilerplate [Chrome Extension Webpack](https://github.com/sszczep/chrome-extension-webpack) from Sebastian Szczepański. You can find the original license text inside [LICENSE.original](./LICENSE.original).
 

docs/DeveloperGuide.md

@@ -150,6 +150,14 @@ Those workflows are running automatically after having some changes to the remot
       manually afterward
     - to automatically publish an application after the review, check "Publish '<application name>'
       automatically after it has passed review" when submitting to review
+  - Firefox
+    - a mozilla developer account is required
+    - any secrets that are necessary for the publication process are set as `Actions secret`
+    - any additional information, see [Submitting an add-on](https://extensionworkshop.com/documentation/publish/submitting-an-add-on/)
+    - after publishing the application, a review is usually pending and will be published afterward
+      - _Note_:
+        - the add-on may be subject to additional review.
+        - you will receive a notification about the outcome of the review at a later time.
 
 ## Open-Source Software compliance