Distributable ZIP-package

.gitattributes

@@ -0,0 +1 @@
+octoprint_octorelay/_static_version.py export-subst

.github/workflows/CI.yaml

@@ -23,11 +23,9 @@ jobs:
           node-version: 18.x
       - name: Cache node modules
         uses: actions/cache@v3
-        env:
-          cache-name: cache-yarn
         with:
           path: ${{ steps.yarnCache.outputs.dir }}
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-build-cache-yarn-${{ hashFiles('**/yarn.lock') }}
       - name: Install dependencies
         working-directory: ts
         run: yarn install
@@ -47,15 +45,6 @@ jobs:
       - name: Build JS
         working-directory: ts
         run: yarn build
-      - name: Check changes
-        # https://unix.stackexchange.com/questions/155046/determine-if-git-working-directory-is-clean-from-a-script
-        run: |
-          if output=$(git status --porcelain) && [ -z "$output" ]; then
-            echo OK
-          else
-            echo Building the JS caused changes that has to be committed and pushed manually.
-            exit 1
-          fi
 
   Python:
     name: Python ${{ matrix.python }}, OctoPrint ${{ matrix.octoprint }}
@@ -81,11 +70,9 @@ jobs:
         run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
       - name: Cache pip modules
         uses: actions/cache@v3
-        env:
-          cache-name: cache-pip
         with:
           path: ${{ steps.pipCache.outputs.dir }}
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-python-${{ matrix.python }}-octoprint-${{ matrix.octoprint}}
+          key: ${{ runner.os }}-build-cache-pip-python-${{ matrix.python }}-octoprint-${{ matrix.octoprint}}
       - name: Install OctoPrint
         # see https://stackoverflow.com/questions/49854628/how-do-i-pip-install-the-latest-patch-number-of-a-package
         run: pip install octoprint~=${{ matrix.octoprint }}.0
@@ -103,8 +90,8 @@ jobs:
       - name: Report the coverage
         working-directory: octoprint_octorelay
         run: |
-          python -m coverage lcov --omit=test*
-          python -m coverage report --show-missing --omit=test*
+          python -m coverage lcov --omit=test*,_version*
+          python -m coverage report --show-missing --omit=test*,_version*
       - name: Coveralls
         uses: coverallsapp/github-action@v2
         continue-on-error: true

.github/workflows/release.yaml

@@ -0,0 +1,125 @@
+# https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Release
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build the distribution
+    runs-on: ubuntu-latest
+    env:
+      NODE_VERSION: 18.x
+      PYTHON_VERSION: 3.11
+      OCTOPRINT_VERSION: 1.9
+    steps:
+    ### UI
+    - name: Get yarn cache dir
+      id: yarnCache
+      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Install Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ env.NODE_VERSION }}
+    - name: Cache node modules
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.yarnCache.outputs.dir }}
+        key: ${{ runner.os }}-release-cache-yarn-${{ hashFiles('**/yarn.lock') }}
+    - name: Install UI dependencies
+      working-directory: ts
+      run: yarn install
+    - name: Build JS
+      working-directory: ts
+      run: yarn build
+    ### Python
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+    - name: Get pip cache dir
+      id: pipCache
+      run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+    - name: Cache pip modules
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.pipCache.outputs.dir }}
+        key: ${{ runner.os }}-release-cache-pip
+    - name: Install distribution dependencies
+      run: pip install --upgrade wheel setuptools pip
+    - name: Install OctoPrint
+      run: pip install octoprint~=${{ env.OCTOPRINT_VERSION }}.0
+    ### Packing
+    - name: Build distribution package
+      run: python setup.py sdist --formats=zip
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: dist
+        path: dist
+
+  integration:
+    name: Integration test on Python ${{ matrix.python }}, OctoPrint ${{ matrix.octoprint }}
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
+        octoprint: [ "1.8", "1.9" ]
+        exclude:
+          # These versions are not compatible to each other:
+          - python: 3.11
+            octoprint: 1.8
+          - python: 3.10
+            octoprint: 1.8
+    steps:
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - name: Install OctoPrint
+        run: pip install octoprint~=${{ matrix.octoprint }}.0
+      - name: Install Wheel
+        # see https://community.octoprint.org/t/setuptools-error-while-installing-plugin-octoklipper-on-manual-op-installation/51387
+        if: matrix.octoprint == '1.8'
+        run: pip install wheel
+      - name: Install the distributed package
+        run: pip install dist/OctoRelay-*.zip
+
+  attach:
+    name: Attaching asset to the release
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - integration
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - name: Rename to release.zip
+        run: cp dist/OctoRelay-*.zip release.zip
+      - name: Get release ID
+        id: get_release
+        uses: bruceadams/get-release@v1.3.2
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+      - name: Attach the asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.get_release.outputs.upload_url }}
+          asset_path: release.zip
+          asset_name: release.zip
+          asset_content_type: application/zip

.gitignore

@@ -1 +1,3 @@
 .idea
+__pycache__
+OctoRelay.egg-info

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Version 2
 
+### 2.3.0
+
+- Changing the release type to distributable package.
+  - Plugin version is now set automatically from GitHub release using `miniver`.
+  - A workflow creates a packages and attaches it as the release's asset.
+  - Thus, redundant files are removed from the distribution.
+  - The latest release distribution URL has changed to:
+
+```    
+https://github.com/borisbu/OctoRelay/releases/download/latest/release.zip
+```
+
 ### 2.2.4
 
 - Fixed UI/UX bug.

MANIFEST.in

@@ -1,4 +1,5 @@
 include README.md
+include CHANGELOG.md
 recursive-include octoprint_octorelay/templates *
 recursive-include octoprint_octorelay/translations *
 recursive-include octoprint_octorelay/static *

README.md

@@ -26,7 +26,7 @@ Install via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bu
 or manually using this URL:
 
 ```
-https://github.com/borisbu/OctoRelay/archive/master.zip
+https://github.com/borisbu/OctoRelay/releases/download/latest/release.zip
 ```
 
 In case you want to enable the plugin for user groups other than admins and users (operators), you need to 

octoprint_octorelay/__init__.py

@@ -312,3 +312,5 @@ def input_polling(self):
     "octoprint.comm.protocol.atcommand.sending":
         __plugin_implementation__.process_at_command
 }
+
+from octoprint_octorelay._version import __version__

octoprint_octorelay/_static_version.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# This file is part of 'miniver': https://github.com/jbweston/miniver
+#
+# This file will be overwritten by setup.py when a source or binary
+# distribution is made.  The magic value "__use_git__" is interpreted by
+# version.py.
+
+version = "__use_git__"
+
+# These values are only set if the distribution was created with 'git archive'
+refnames = "$Format:%D$"
+git_hash = "$Format:%h$"