Merge pull request #64 from offbyone/ci-build-and-test

Add CI via GitHub Actions

.github/workflows/ci.yml

@@ -0,0 +1,187 @@
+---
+name: CI
+
+on:
+  merge_group:
+  push:
+    branches: [main, "ci-*"]
+    tags: ["*"]
+  pull_request:
+    branches: [main, "ci-*"]
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PIP_NO_PYTHON_VERSION_WARNING: "1"
+
+permissions: {}
+
+jobs:
+  build-package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: hynek/build-and-inspect-python-package@v2
+        id: baipp
+        with:
+          skip-wheel: true
+
+    outputs:
+      # Used to define the matrix for tests below. The value is based on
+      # packaging metadata (trove classifiers).
+      supported-python-versions: ${{ steps.baipp.outputs.supported_python_classifiers_json_array }}
+
+  tests:
+    name: Tests on ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    needs: build-package
+
+    strategy:
+      fail-fast: false
+      matrix:
+        # Created by the build-and-inspect-python-package action above.
+        python-version: ${{ fromJson(needs.build-package.outputs.supported-python-versions) }}
+
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+      - uses: hynek/setup-cached-uv@v2
+      - run: uv venv
+      - run: uv pip install .[dev]
+      - run: |
+          cd tests
+          uv run coverage run -p -m pytest
+
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-data-${{ matrix.python-version }}
+          path: tests/.coverage.*
+          include-hidden-files: true
+
+  coverage:
+    name: Combine & check coverage
+    runs-on: ubuntu-latest
+    needs: tests
+
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Download coverage data
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-data-*
+          merge-multiple: true
+
+      - run: uv venv
+      - name: Combine coverage & fail if it's <70%.
+        run: |
+          uv pip install --system coverage[toml]
+
+          uv run coverage combine
+          uv run coverage html --skip-covered --skip-empty
+
+          # Report and write to summary.
+          uv run coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+          # Report again and fail if under 70%.
+          uv run coverage report --fail-under=70
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+        if: ${{ failure() }}
+
+  docs:
+    name: Build docs & run doctests
+    runs-on: ubuntu-latest
+    needs: build-package
+    steps:
+      - name: Download pre-built packages
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - run: tar xf dist/*.tar.gz --strip-components=1
+      - uses: actions/setup-python@v5
+        with:
+          # Keep in sync with tox/docs and .readthedocs.yaml.
+          python-version: "3.12"
+      - uses: hynek/setup-cached-uv@v2
+      - run: uv venv
+
+  # pyright:
+  #   name: Check types using pyright
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #     - uses: actions/setup-python@v5
+  #       with:
+  #         python-version-file: .python-version-default
+  #     - uses: hynek/setup-cached-uv@v2
+
+  #     - run: uv venv
+  #     - run: uv pip install .[dev] pyright typing
+  #     - run: uv run pyright src
+
+  install-dev:
+    name: Verify dev env
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+      - uses: hynek/setup-cached-uv@v2
+
+      - run: uv venv --python $(cat .python-version-default)
+      - run: uv pip install -e .[dev]
+
+      - name: Ensure we can import the fediblockhole package
+        run: |
+          source .venv/bin/activate
+
+          python -Ic 'import fediblockhole; print(fediblockhole.__version__)'
+
+  # Ensure everything required is passing for branch protection.
+  required-checks-pass:
+    if: always()
+
+    needs:
+      - coverage
+      - docs
+      - install-dev
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.python-version-default

@@ -0,0 +1 @@
+3.12

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.4.6"
 description = "Federated blocklist management for Mastodon"
 readme = "README.md"
 license = {file = "LICENSE"}
-requires-python = ">=3.6"
+requires-python = ">=3.8"
 keywords = ["mastodon", "fediblock"]
 authors = [ 
     {name = "Justin Warren"}, {email = "justin@eigenmagic.com"}
@@ -19,8 +19,6 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.6",
 ]
 dependencies = [
     "requests",
@@ -42,4 +40,13 @@ build-backend = "hatchling.build"
 [tool.pytest.ini_options]
 addopts = [
     "--import-mode=importlib",
-]
+]
+norecursedirs = [
+    "tests/helpers",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "coverage[toml]>=7.6.1",
+    "pytest ~= 8.3",
+]