Migrate to the new Elgato CLI tool

Author: ChrisRegado

.github/workflows/streamdeck-plugin-build.yml

@@ -38,18 +38,24 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.13"
+
       - name: Set up Pip
         run: python -m pip install --upgrade pip
+
       - name: pip install
         run: pip install -r requirements.txt
+
       - name: Run unit tests
         run: python -m unittest
+
       - name: Bundle plugin
         run: pyinstaller --clean --dist ../com.chrisregado.googlemeet.sdPlugin/dist/${{ matrix.os }} src/main.py && rm -rf build
+
       - uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.os }}-plugin-intermediate-build
@@ -65,26 +71,47 @@ jobs:
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
-      - name: Download DistributionTool
-        run: curl -L https://github.com/ChrisRegado/streamdeck-build-tools/raw/master/DistributionToolMac/DistributionTool -o DistributionTool
-      - name: Make DistributionTool Executable
-        run: chmod +x DistributionTool
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          # See https://docs.elgato.com/streamdeck/cli/intro/ for supported Node.js versions
+          node-version: '22'
+
+      - name: Install Elgato streamdeck CLI tool
+        run: npm install -g @elgato/cli@1.5.0
+
       - name: Download macOS plugin artifact
         uses: actions/download-artifact@v4
         with:
           name: macos-plugin-intermediate-build
           path: com.chrisregado.googlemeet.sdPlugin/dist/macos
+
       - name: Download Windows plugin artifact
         uses: actions/download-artifact@v4
         with:
           name: windows-plugin-intermediate-build
           path: com.chrisregado.googlemeet.sdPlugin/dist/windows
+
+      - name: Run Elgato linter
+        run: streamdeck validate --no-update-check com.chrisregado.googlemeet.sdPlugin
+
       - name: Make output dir
-        run: mkdir output
+        run: mkdir ./build
+
       - name: Bundle plugin
-        run: ./DistributionTool -b -i ./com.chrisregado.googlemeet.sdPlugin -o output/
+        if: ${{ github.ref_type != 'tag' }}
+        run: streamdeck pack --output ./build/ --no-update-check com.chrisregado.googlemeet.sdPlugin
+
+      - name: Bundle plugin using version from git tag
+        if: ${{ github.ref_type == 'tag' }}
+        run: |
+          GIT_TAG="${{ github.ref_name }}"
+          VERSION_NUMBER="${GIT_TAG#v}"
+          streamdeck pack --output ./build/ --no-update-check --force --version "${VERSION_NUMBER}" com.chrisregado.googlemeet.sdPlugin
+
       - name: Upload final plugin binary
         uses: actions/upload-artifact@v4
         with:
           name: com.chrisregado.googlemeet.streamDeckPlugin
-          path: output/com.chrisregado.googlemeet.streamDeckPlugin
+          path: ./build/com.chrisregado.googlemeet.streamDeckPlugin

.gitignore

@@ -145,6 +145,7 @@ dmypy.json
 DistributionTool.exe
 DistributionTool
 com.chrisregado.googlemeet.streamDeckPlugin
+node_modules
 
 # Browser extension build artifacts
 browser-extension/build/

README.md

@@ -59,15 +59,15 @@ In the Stream Deck desktop app, right click on one of the Google Meet actions in
 
 The Stream Deck plugin launches a localhost-only Websocket server on port 2394, which our browser extension connects to. The plugin and browser extension send messages back and forth over that websocket to notify the Stream Deck when Meet changes its device on/off status, and simulates Meet mute button clicks in your browser when you press a key on your Stream Deck.
 
-The Stream Deck plugin code is in the `streamdeck-plugin` directory. The browser extension code is in the `browser-extension` directory. The `com.chrisregado.googlemeet.sdPlugin` directory contains our Stream Deck assets and it becomes our Stream Deck plugin distributable once we bundle our code with the Elgato DistributionTool.
+The Stream Deck plugin code is in the `streamdeck-plugin` directory. The browser extension code is in the `browser-extension` directory. The `com.chrisregado.googlemeet.sdPlugin` directory contains our Stream Deck assets and it becomes our Stream Deck plugin distributable once we bundle our code with the Elgato `streamdeck` CLI.
 
 ## Developing the Stream Deck Plugin
 
 ### First Time Setup
 
 The plugin is written in Python. Create a venv to hold your package's dependencies, and install those dependencies:
 
-MacOS:
+**MacOS:**
 
 ```
 cd streamdeck-plugin
@@ -76,7 +76,7 @@ source venv/bin/activate
 pip install -r requirements.txt
 ```
 
-Windows:
+**Windows:**
 
 ```
 cd streamdeck-plugin
@@ -89,15 +89,15 @@ Remember that virtualenvs are not portable. If you move this folder at all, you'
 
 ### Running Unit Tests
 
-MacOS:
+**MacOS:**
 
 ```
 cd streamdeck-plugin
 source venv/bin/activate
 python -m unittest
 ```
 
-Windows:
+**Windows:**
 
 ```
 cd streamdeck-plugin
@@ -107,11 +107,13 @@ python -m unittest
 
 ### Bundling
 
-We use `pyinstaller` to bundle our code, dependencies, and a Python runtime environment into an executable. We put that executable into the `com.chrisregado.googlemeet.sdPlugin` folder, which in turn gets zipped up by the [Elgato DistributionTool](https://developer.elgato.com/documentation/stream-deck/sdk/packaging/) as our final distributable plugin package. That plugin package ends up including any assets we need (e.g. icons), the `manifest.json` file that defines our plugin for the Stream Deck desktop app, and our executable plugin code. Double-click that plugin package and the Stream Deck software will prompt you to install it.
+We use `pyinstaller` to bundle our code, dependencies, and a Python runtime environment into an executable. We put that executable into the `com.chrisregado.googlemeet.sdPlugin` folder, which in turn gets zipped up by the [Elgato streamdeck CLI tool](https://docs.elgato.com/streamdeck/cli/intro) as our final distributable plugin package. That plugin package ends up including any assets we need (e.g. icons), the `manifest.json` file that defines our plugin for the Stream Deck desktop app, and our executable plugin code. Double-click that plugin package and the Stream Deck software will prompt you to install it.
 
-To build the bundle:
+Our plugin code is written in Python, but the Elgato CLI tool is distributed as a Node module, so you'll need Node.js installed.
 
-MacOS:
+To build the plugin:
+
+**MacOS:**
 
 ```
 cd streamdeck-plugin
@@ -121,7 +123,7 @@ pyinstaller --clean --dist "../com.chrisregado.googlemeet.sdPlugin/dist/macos" s
 rm -rf build
 ```
 
-Windows:
+**Windows:**
 
 ```
 cd streamdeck-plugin
@@ -133,23 +135,36 @@ rmdir /q /s build
 
 Note that the resulting executable is only valid for the OS you built it on. MacOS and Windows bundles must be created separately from a machine/VM of that OS, and then combined into the `com.chrisregado.googlemeet.sdPlugin/dist/` folder with `macos` and `windows` subdirectories for release.
 
-If you're just testing locally (so you only care about one OS), you can place any file in the other OS's executable location (`CodePath`s from `manifest.json`) to appease the Elgato DistributionTool. Example:
+If you're just testing locally (so you only care about one OS), you can place any file in the other OS's executable location (`CodePath`s from `manifest.json`) to appease the Elgato packaging tool. Example:
 
 ```
+# If you're running macOS:
 mkdir -p com.chrisregado.googlemeet.sdPlugin/dist/windows/main
 touch com.chrisregado.googlemeet.sdPlugin/dist/windows/main/main.exe
+
+# If you're running Windows:
+mkdir com.chrisregado.googlemeet.sdPlugin\dist\macos\main
+type nul > com.chrisregado.googlemeet.sdPlugin\dist\macos\main\main
 ```
 
 Or, if you don't ever plan on publishing your local builds, delete the other OS's CodePath and `OS` entry in manifest.json so you don't have to worry about multi-OS support.
 
-Finally, use the DistributionTool to bundle everything into the Stream Deck plugin distributable that you can send to users:
+Finally, use Elgato's `streamdeck` CLI tool to bundle everything into the Stream Deck plugin distributable that you can install or send to users. From the root of this git repo, run:
 
 ```
-./DistributionTool -b -i ./com.chrisregado.googlemeet.sdPlugin -o ~/Desktop/
+npm install -g @elgato/cli
+
+streamdeck pack --output ./build/ --force  com.chrisregado.googlemeet.sdPlugin
 ```
 
+In the Stream Deck desktop app, uninstall any old copies of the plugin because the app won't overwrite your installation unless the new build has a newer version number.
+
+You can then double-click the `./build/com.chrisregado.googlemeet.streamDeckPlugin` file to install your build of the plugin into the Stream Deck desktop app.
+
 ## Developing the Browser Extension
 
+Our build tools rely on Node.js, so make sure you have Node.js installed.
+
 ### Using Google Chrome
 
 Follow the usual "Load unpacked" installation instructions described above, but point Chrome at the `browser-extension` folder of your git workspace instead of using a release artifact. You can then edit the extension's source code and click the reload button on Chrome's extension settings page. (No build commands/steps are needed.) See https://developer.chrome.com/extensions/getstarted for more details.

RELEASE_INSTRUCTIONS.md

@@ -34,16 +34,16 @@ Finally, we'll add auth tokens from the Firefox Add-on portal as GitHub Action s
 
 Follow these steps each time you want to release a new version of the plugin and/or browser extension:
 
-1. Manually update the version number of the Stream Deck plugin by editing `com.chrisregado.googlemeet.sdPlugin/manifest.json` and changing the `Version` field. Make sure that change gets merged into `master`. (We have CI jobs to manage version numbers for the browser extensions, so you don't need to touch those.)
-2. Tag the commit you wish to release and push it to GitHub. We use semantic versioning with a "v" prefix for our releases. For example: `git checkout master && git tag v1.2.3 && git push origin tag v1.2.3`
-3. CI jobs should automatically launch against that tag to build the [Stream Deck plugin](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/streamdeck-plugin-build.yml) and [browser extensions](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/browser-extension-build.yml). (The list of workflow runs should show one copy of each of those two jobs with your `v1.2.3` tag.) Wait for them to complete successfully.
-4. Click into those two build jobs, and on each job's "Summary" tab, download our build artifacts. The browser extension build job should have `chrome-extension` and `firefox-extension-signed` artifacts, and the plugin build job should have `com.chrisregado.googlemeet.streamDeckPlugin`.
-5. Do a final manual validation of those release artifacts. Install the plugin, Firefox extension, and Chrome extension, and verify basic functionality.
-6. On the Github page for your repo, click "Releases". (https://github.com/ChrisRegado/streamdeck-googlemeet/releases)
-7. Click "Draft a new release".
-8. Click the "Tag" button and select the tag you made in the previous step.
-9. Use the your tag name as the "Release title", and enter a description summarizing notable changes in this release.
-10. Select the "Set as a pre-release" checkbox near the bottom of the page.
-11. Click "Publish release".
-12. Our [release CI job](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/release.yaml) should automatically start and attach our tag's artifacts to the GitHub Release. Wait for it to complete. If all goes well, in a minute or two you should see 3 attachments appear on the release: the `com.chrisregado.googlemeet.streamDeckPlugin` plugin, a zip of the Chrome extension, and an `.xpi` file for the Firefox extension.
-13. Edit the release, uncheck the "Set as a pre-release" checkbox at the bottom of the page, select the "Set as the latest release" checkbox, and click "Update release".
+1. Tag the commit you wish to release and push it to GitHub. We use semantic versioning with a "v" prefix for our releases. For example: `git checkout master && git tag v1.2.3 && git push origin tag v1.2.3`
+    * Our CI jobs will update version numbers automatically to match that tag for both the plugin and browser extensions. You don't need to manually change any version numbers in code/config.
+2. CI jobs should automatically launch against that tag to build the [Stream Deck plugin](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/streamdeck-plugin-build.yml) and [browser extensions](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/browser-extension-build.yml). (The list of workflow runs should show one copy of each of those two jobs with your `v1.2.3` tag.) Wait for them to complete successfully.
+3. Click into those two build jobs, and on each job's "Summary" tab, download our build artifacts. The browser extension build job should have `chrome-extension` and `firefox-extension-signed` artifacts, and the plugin build job should have `com.chrisregado.googlemeet.streamDeckPlugin`.
+4. Do a final manual validation of those release artifacts. Install the plugin, Firefox extension, and Chrome extension, and verify basic functionality.
+5. On the Github page for your repo, click "Releases". (https://github.com/ChrisRegado/streamdeck-googlemeet/releases)
+6. Click "Draft a new release".
+7. Click the "Tag" button and select the tag you made in the previous step.
+8. Use the your tag name as the "Release title", and enter a description summarizing notable changes in this release.
+9. Select the "Set as a pre-release" checkbox near the bottom of the page.
+10. Click "Publish release".
+11. Our [release CI job](https://github.com/ChrisRegado/streamdeck-googlemeet/actions/workflows/release.yaml) should automatically start and attach our tag's artifacts to the GitHub Release. Wait for it to complete. If all goes well, in a minute or two you should see 3 attachments appear on the release: the `com.chrisregado.googlemeet.streamDeckPlugin` plugin, a zip of the Chrome extension, and an `.xpi` file for the Firefox extension.
+12. Edit the release, uncheck the "Set as a pre-release" checkbox at the bottom of the page, select the "Set as the latest release" checkbox, and click "Update release".