Clean up GitHub Actions workflows (#883)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

.github/workflows/documentation.yml

@@ -6,20 +6,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+      - uses: actions/checkout@v4
 
       - name: set up python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
+        with:
+          cache: 'pip'
 
       - name: install dependencies
         run: |
-          pip install ".[docs,lint,test]"
+          pip install ".[docs]"
           sudo apt-get -y update
           sudo apt-get -y install graphviz libclang1-11 libclang-cpp11
 

.github/workflows/lint.yml

@@ -6,19 +6,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+      - uses: actions/checkout@v4
+
       - name: set up python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
+        with:
+          cache: 'pip'
 
       - name: install dependencies
         run: |
-          pip install ".[docs,lint,test]"
+          pip install ".[lint]"
 
       - name: lint the source code
         run: make flake8
@@ -28,6 +25,3 @@ jobs:
 
       - name: type check the source code
         run: make type-check
-
-      - name: check version numbers are in sync
-        run: make version-check

.github/workflows/unit_tests.yml

@@ -36,17 +36,12 @@ jobs:
             sphinx-version: '6.1.3'
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/cache@v1
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/*.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
+      - uses: actions/checkout@v4
       - name: set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+          cache: 'pip'
 
       - name: install sphinx from PyPI or from git
         run: |
@@ -58,7 +53,7 @@ jobs:
 
       - name: install dependencies
         run: |
-          pip install .[
+          pip install ".[test]"
 
       - name: run the unit tests
         run: make dev-test

Makefile

@@ -45,7 +45,3 @@ black:
 .PHONY: type-check
 type-check:
 	mypy --warn-redundant-casts --warn-unused-ignores breathe tests
-
-.PHONY: version-check
-version-check:
-	 PYTHONPATH=../:$(PYTHONPATH) python3 scripts/version-check.py

breathe-apidoc.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 
 import sys
 

documentation/source/conf.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-#
 # BreatheExample documentation build configuration file, created by
 # sphinx-quickstart on Tue Feb  3 18:20:48 2009.
 #

mkrelease

@@ -66,6 +66,7 @@ upload()
 (
 	cd -- mkrelease_tmp
 
+	twine check --strict dist/*
 	twine upload -- dist/*
 
 	{

tests/warnings/source/conf.py

@@ -1,4 +1,3 @@
-#
 # Test Breathe Warnings documentation build configuration file, created by
 # sphinx-quickstart on Thu Jun  5 18:57:21 2014.
 #