.github/dependabot.yml

@@ -5,9 +5,9 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"
 
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "monthly"

.github/workflows/lighthouserc.json

@@ -9,9 +9,9 @@
     },
     "assert": {
       "assertions": {
-        "categories:performance": ["error", { "minScore": 0.85 }],
-        "categories:accessibility": ["error", { "minScore": 0.85 }],
-        "categories:best-practices": ["error", { "minScore": 0.85 }]
+        "categories:performance": ["error", { "minScore": 0.8 }],
+        "categories:accessibility": ["error", { "minScore": 0.8 }],
+        "categories:best-practices": ["error", { "minScore": 0.8 }]
       }
     }
   }

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+# This will run every time a tag is created and pushed to the repository.
+# It calls our tests workflow via a `workflow_call`, and if tests pass
+# then it triggers our upload to PyPI for a new release.
+name: Publish to PyPI
+on:
+  release:
+    types: ["published"]
+
+jobs:
+  tests:
+    uses: ./.github/workflows/tests.yml
+  publish:
+    name: publish
+    needs: [tests] # require tests to pass before deploy runs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v3
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Build package
+        run: |
+          sudo apt-get install gettext
+          python -m pip install -U pip build
+          python -m build
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@v1.6.4
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_KEY }}

.github/workflows/tests.yml

@@ -6,6 +6,7 @@ on:
     tags:
       - 'v*'
   pull_request:
+  workflow_call:
 
 env:
   PY_COLORS: 1
@@ -16,30 +17,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
+    - uses: actions/setup-python@v4
       with:
         python-version: 3.9
-    - uses: pre-commit/action@v2.0.3
+    - uses: pre-commit/action@v3.0.0
 
   tests:
     strategy:
       matrix:
         os: [ubuntu-latest]
         python-version: [3.7, 3.8, 3.9]
-        sphinx: [">=3,<4", ">=4,<5"]
+        # Only test the latest major release of Sphinx because otherwise we need to
+        # keep multiple versions of regression tests on file and this creates lots of
+        # noise in the tests.
+        sphinx: [">=6,<7"]
         include:
         - os: windows-latest
           python-version: 3.9
-          sphinx: ">=3,<4"
+          sphinx: ">=6,<7"
         - os: macos-latest
           python-version: 3.9
-          sphinx: ">=4,<5"
+          sphinx: ">=6,<7"
     runs-on: ${{ matrix.os }}
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+    - name: Set up Python ${{ matrix.python-version }} and Sphinx ${{ matrix.sphinx }}
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
         cache: "pip"
@@ -54,9 +58,10 @@ jobs:
       run: >
         pytest --durations=10 --cov=sphinx_book_theme --cov-report=xml --cov-report=term-missing
 
+    # Only upload to codecov on pull requests so that we don't trigger rate limit blocks
     - name: Upload to Codecov
-      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7 && github.repository == 'executablebooks/sphinx-book-theme'
-      uses: codecov/codecov-action@v3.1.0
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7 && github.repository == 'executablebooks/sphinx-book-theme' && github.event_name == 'pull_request'
+      uses: codecov/codecov-action@v3.1.1
       with:
         name: ebp-sbt-pytests-py3.7
         flags: pytests
@@ -70,7 +75,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: '3.7'
         cache: "pip"
@@ -80,7 +85,9 @@ jobs:
         python -m pip install --upgrade pip
         pip install -e .[doc]
 
+    # Only check for broken links on pull requests so that we don't block releases
     - name: Check for broken links
+      if: github.event_name == 'pull_request'
       run: >
         sphinx-build -b linkcheck docs docs/_build/linkcheck
 
@@ -93,39 +100,15 @@ jobs:
       run: |
         from pathlib import Path
         text = Path("./warnings.txt").read_text().strip()
+        expected_warning_snippets = ["kitchen-sink", "urllib/parse.py"]
         print("\n=== Sphinx Warnings ===\n\n" + text)  # Print just for reference so we can look at the logs
-        unexpected = [ii for ii in text.split("\n") if "kitchen-sink" not in ii]
+        unexpected = [ii for ii in text.split("\n") if not any(snippet in ii for snippet in expected_warning_snippets)]
         assert len(unexpected) == 0
 
     - name: Audit with Lighthouse
-      uses: treosh/lighthouse-ci-action@9.3.0
+      uses: treosh/lighthouse-ci-action@9.3.1
       with:
         configPath: ".github/workflows/lighthouserc.json"
         temporaryPublicStorage: true
         uploadArtifacts: true
         runs: 5
-
-  publish:
-    name: Publish to PyPI
-    needs: [pre-commit, tests]
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
-
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v3
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v3
-        with:
-          python-version: 3.7
-
-      - name: Build package
-        run: |
-          python -m pip install -U pip build
-          python -m build
-
-      - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.5.0
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_KEY }}

.gitignore

@@ -138,3 +138,6 @@ node_modules/
 # Editors
 .vscode/
 .idea
+
+# Files we create automatically
+docs/content/pydata-content-blocks.md

.pre-commit-config.yaml

@@ -5,10 +5,16 @@ exclude: >
     (?x)^(
       \.vscode/settings\.json|
     )$
+
+# Fix the node version to avoid a GLIBC error
+# ref: https://stackoverflow.com/questions/71939099/bitbucket-pipeline-error-installing-pre-commit-ts-lint/71940852#71940852
+default_language_version:
+    node: 16.14.2
+
 repos:
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
     - id: check-toml
     - id: check-json
@@ -17,17 +23,17 @@ repos:
     - id: trailing-whitespace
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 6.0.0
     hooks:
     - id: flake8
 
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.1.0
     hooks:
     - id: black
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.6.2
+    rev: v3.0.0-alpha.4
     hooks:
       - id: prettier
         types_or: [scss, javascript]