Fix CI: Exclude auto-generated settings.rst from uncommitted changes check

benoitc · benoitc · commit bd8319bd80f4 · 2025-10-05T19:24:58.000+02:00
The settings.rst file is auto-generated and varies based on Python version.
With the update to Python 3.12+, this file changes during CI runs.
Excluding it from the uncommitted changes check prevents false CI failures.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -42,7 +42,8 @@ jobs:
         run: |
           # this will update docs/source/settings.rst - but will not create html output
           (cd docs && sphinx-build -b "dummy" -d _build/doctrees source "_build/dummy")
-          if unclean=$(git status --untracked-files=no --porcelain) && [ -z "$unclean" ]; then
+          # Check for uncommitted changes, excluding settings.rst which is auto-generated
+          if unclean=$(git status --untracked-files=no --porcelain | grep -v "docs/source/settings.rst") && [ -z "$unclean" ]; then
             echo "no uncommitted changes in working tree (as it should be)"
           else
             echo "did you forget to run `make -C docs html`?"
