Merge pull request #2 from strohganoff/ci-workflow

Add github action for running tests

Author: strohganoff

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@6f7e8d9c0b1a2c3d4e5f6a7b8c9d0e1f2a3b4c5d

.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+on: 
+  push:
+    branches: [main]
+    paths-ignore: ['*.md', '.gitignore']
+  pull_request:
+    types: [opened, synchronize, labeled]
+    branches: [main]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' ||
+        ((github.event.action == 'opened' || github.event.action == 'synchronize') && contains(github.event.pull_request.labels.*.name, 'READY TO TEST')) ||
+        (github.event.action == 'labeled' && github.event.label.name == 'READY TO TEST')
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          cache: 'pip'
+          python-version: "3.x"
+      - run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[dev]
+      - name: Test with pytest and python version
+        run: pytest -p no:sugar --cov=streamdeck --cov-report=xml --cov-report=html --cov-report=term --junit-xml=reports/xunit-results.xml
+      - name: Upload test coverage reports to artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-coverage-reports
+          path: reports/
+        if: ${{ always() }}

pyproject.toml

@@ -7,7 +7,7 @@
 
 [project]
     name = "streamdeck-plugin-sdk"
-    version = "0.3.0"
+    dynamic = ["version"]
     description = "Write Streamdeck plugins using Python"
     readme = "README.md"
     authors = [
@@ -53,6 +53,9 @@
     include = ["streamdeck*"]
     exclude = ["tests"]
 
+[tool.setuptools.dynamic]
+    version = {attr = "streamdeck.utils._version.MODULE_VERSION"}
+
 
 # Add type annotations to your Python programs, and use mypy to type check them.
 [tool.mypy]

streamdeck/utils/_version.py

@@ -0,0 +1,68 @@
+"""This module provides dynamic versioning for the package, intended for use in GitHub Actions during a release event.
+
+The version is extracted from the release tag in the GitHub event data.
+If this ins't a release, or isn't running in a GitHub runner, or something is missing,
+the script will fall back to version "0.0.1", to allow for testing.
+
+Future Improvements:
+- I may either improve this to handle local building as well as merging into 'main' branch,
+    or just go with setuptools_scm to replace all of this.
+"""
+from __future__ import annotations
+
+import json
+import logging
+import os
+
+
+# NOTE: A single variable is set using this function below.
+def get_version():
+    """Retrieve the version from GitHub Actions environment variables.
+
+    Raises:
+        RuntimeError: If not running in GitHub Actions or the event is not a release.
+        FileNotFoundError: If the GitHub event path file is not found.
+        json.JSONDecodeError: If the event data cannot be parsed as JSON.
+        ValueError: If the release tag is not found in the event data.
+
+    Returns:
+        str: The version extracted from the release tag.
+    """
+    if os.getenv("GITHUB_ACTIONS") != "true":
+        logging.error("Missing $GITHUB_ACTIONS environment variable. This script must (currently) be run in a GitHub Actions environment.")
+        return "0.0.1"
+    # May restrict the event type in the future.
+    # if os.getenv("GITHUB_EVENT_NAME") != "release":
+    #     logging.error("Missing $GITHUB_EVENT_NAME environment variable or not a release event. This script must (currently) be triggered by a release event.")
+    #     return "0.0.1"
+
+    event_path = os.getenv("GITHUB_EVENT_PATH")
+
+    if not event_path:
+        logging.error("Missing $GITHUB_EVENT_PATH environment variable. Unable to locate the GitHub event data file.")
+        return "0.0.1"
+
+    try:
+        with open(event_path) as f:
+            event_data = json.load(f)
+    except FileNotFoundError as e:
+        logging.exception("Error reading event data from file.")
+        return "0.0.1"
+    except json.JSONDecodeError as e:
+        logging.exception("Error parsing event data as JSON.")
+        return "0.0.1"
+
+    # May restrict the action type in the future.
+    # if event_data.get("action") != "published":
+    #     return "0.0.1"
+
+    tag_name = event_data.get("release", {}).get("tag_name")
+
+    if not tag_name:
+        logging.error("No tag version found in event_data file.")
+        return "0.0.1"
+
+    return tag_name.lstrip("v")
+
+
+MODULE_VERSION = get_version()