MNT: Untangle CI workflow into separate jobs

Author: kernc

.github/actions/setup/action.yml

@@ -0,0 +1,21 @@
+name: 'Default Checkout'
+description: 'checkout & setup'
+inputs:
+  python-version:
+    description: 'Python version'
+    required: true
+    default: '>=3'
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+    - uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cache/pip
+          ~\AppData\Local\pip\Cache
+          ~/Library/Caches/pip
+        key: ${{ runner.os }}-py${{ inputs.python-version }}

.github/workflows/ci.yml

@@ -5,69 +5,54 @@ on:
   schedule: [ cron: '12 2 6 * *' ]
 
 jobs:
-  build:
-    name: Build
+  test-matrix:
     runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+        with:
+          python-version: '>=3'
 
-    strategy:
-      matrix:
-        python-version: [3.11, '>=3']
-        include:
-          - python-version: 3.11
-            test-type: lint
-          - python-version: 3.11
-            test-type: docs
+      - run: pip install -U pip setuptools wheel && pip install -U .
+      - run: time python -m unittest -v pdoc.test
 
+  lint-test-coverage:
+    runs-on: ubuntu-latest
     steps:
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v4
         with:
-          python-version: ${{ matrix.python-version }}
-
-      - uses: actions/cache@v4
-        name: Set up caches
+          fetch-depth: 2  # For codecov
+      - uses: ./.github/actions/setup
         with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-py${{ matrix.python-version }}
+          python-version: 3.11
 
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 3
-      - name: Fetch tags
-        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-
-      - name: Install dependencies
-        run: |
-          pip install -U pip setuptools wheel
-          pip install -U .
+      - run: pip install -U pip setuptools wheel && pip install -U .
 
       - name: Install lint dependencies
-        if: matrix.test-type == 'lint'
         run: |
           pip install flake8 coverage mypy types-Markdown
           sudo apt update && sudo apt-get install \
             texlive-xetex lmodern texlive-fonts-recommended  # test_pdf_pandoc
           wget -O/tmp/pandoc.deb https://github.com/jgm/pandoc/releases/download/2.10/pandoc-2.10-1-amd64.deb && sudo dpkg -i /tmp/pandoc.deb
 
-      - name: Install docs dependencies
-        if: matrix.test-type == 'docs'
-        run: pip install -e .
+      - run: find -name '*.md' | xargs .github/lint-markdown.sh
+      - run: flake8
+      - run: mypy -p pdoc
+      - run: time coverage run -m unittest -v pdoc.test
+      - run: bash <(curl -s https://codecov.io/bash)
+      - run: coverage report
+      - run: PDOC_TEST_PANDOC=1 time python -m unittest -v pdoc.test.CliTest.test_pdf_pandoc
 
-      - name: Test w/ Coverage, Lint
-        if: matrix.test-type == 'lint'
-        run: |
-          find -name '*.md' | xargs .github/lint-markdown.sh
-          flake8
-          mypy -p pdoc
-          time coverage run -m unittest -v pdoc.test
-          PDOC_TEST_PANDOC=1 time catchsegv python -m unittest -v pdoc.test.CliTest.test_pdf_pandoc
-          bash <(curl -s https://codecov.io/bash)
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+        with:
+          python-version: 3.11
 
-      - name: Test
-        if: '! matrix.test-type'
-        run: time python -m unittest -v pdoc.test
+      - name: Fetch tags
+        run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
 
-      - name: Test docs
-        if: matrix.test-type == 'docs'
-        run: time doc/build.sh
+      - run: pip install -U pip setuptools wheel && pip install -e .
+      - run: time doc/build.sh

README.md

@@ -8,7 +8,7 @@ pdoc
 [![package downloads](https://img.shields.io/pypi/dm/pdoc3.svg?color=skyblue&style=for-the-badge)](https://pypi.org/project/pdoc3)
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/kernc?color=pink&style=for-the-badge)](https://github.com/sponsors/kernc)
 
-Auto-generate API documentation for Python projects.
+Auto-generate API documentation for Python 3+ projects.
 
 [**Project website**](https://pdoc3.github.io/pdoc/)