Merge pull request #809 from LincolnPuzey/ci_improvements

Github actions CI maintenance and improvements

Author: LincolnPuzey

.github/workflows/push.yml

@@ -1,21 +1,55 @@
 name: CI
 on: [push, pull_request]
 jobs:
-  lint:
-    runs-on: ubuntu-24.04
-    name: lint
+  black:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
-          python-version: "3.13"
-      - run: |
-          sudo apt-get update
-          sudo apt-get remove libhashkit2 libmemcached11 || true
-          sudo apt-get install -y libmemcached-dev
-      - run: pip install tox
-      - run: tox -e lint
-      - run: tox -e docs
+          python-version: "3.10"
+      - run: pip install --group format
+      - run: black --check .
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - run: pip install ".[all]" --group type-check
+      - run: mypy
+
+  isort:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - run: pip install --group lint
+      - run: isort --check dramatiq tests
+
+  flake8:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - run: pip install --group lint
+      - run: flake8 dramatiq tests examples
+
+  documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - run: pip install ".[all]" --group docs
+      - run: cd docs && make html
 
   build-unix:
     timeout-minutes: 30
@@ -47,9 +81,13 @@ jobs:
         ports:
           - 6379:6379
 
+    env:
+      RABBITMQ_USERNAME: "dramatiq"
+      RABBITMQ_PASSWORD: "dramatiq"
+
     steps:
-      - uses: actions/checkout@master
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python }}
       - run: |
@@ -59,11 +97,5 @@ jobs:
       - run: pip install -e '.[all]' --group test
       - run: pytest --benchmark-skip
         if: ${{ matrix.concurrency == 'cpython' }}
-        env:
-          RABBITMQ_USERNAME: "dramatiq"
-          RABBITMQ_PASSWORD: "dramatiq"
       - run: python pytest-gevent.py --benchmark-skip
         if: ${{ matrix.concurrency == 'gevent' }}
-        env:
-          RABBITMQ_USERNAME: "dramatiq"
-          RABBITMQ_PASSWORD: "dramatiq"

.github/workflows/release.yml

@@ -9,13 +9,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
       - name: Install dependencies
-        run: python -m pip install build
+        run: pip install --group build
 
       - name: Build dist packages
         run: python -m build .

CONTRIBUTING.md

@@ -24,7 +24,8 @@ To set up a development environment, it is recommended to:
 ### Pull Requests
 
 * Make sure any code changes are covered by tests.
-* Run [isort] and [black] on any modified files.
+* Run [black], [isort] and [flake8] on any modified files.
+* Run [mypy] to check type correctness.
 * If this is your first contribution, add yourself to the [CONTRIBUTORS] file.
 * If your branch is behind master, [rebase] on top of it.
 
@@ -37,6 +38,8 @@ Run the test suite with `tox`.  The tests require running [RabbitMQ],
 [Memcached]: https://memcached.org/
 [isort]: https://github.com/timothycrosley/isort
 [black]: https://github.com/psf/black
+[flake8]: https://flake8.pycqa.org/en/latest/
+[mypy]: https://mypy.readthedocs.io/en/stable/getting_started.html
 [rebase]: https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request
 
 

pyproject.toml

@@ -32,6 +32,8 @@ format = [
 ]
 type-check = [
     "mypy",
+    # Include test group so mypy can see the types of the pytest modules the tests import.
+    {include-group = "test"},
 ]
 build = [
     "build",