From 8e12fb06b22755ed5388a60f867729381caa2bba Mon Sep 17 00:00:00 2001 From: Lucas Hoffmann Date: Tue, 13 Aug 2024 23:17:30 +0200 Subject: [PATCH 1/2] Add a ci check for the generated docs We had this check when ci was still run on travis. The commit f1bbd00862d2b6b050c755f36262597af22bb824 indicates that such a check is currently needed. --- .github/workflows/check.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 56f7c9a70..b91d3ebc8 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -47,3 +47,21 @@ jobs: - name: Build the ${{ matrix.derivation }} derivation run: 'nix build --print-build-logs .\#${{ matrix.derivation }}' + + + generated-docs: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + + - name: Regenerate all generated docs + # We run "true" instead of "sphinx-build" to speed things up as we are + # only interested in the regeneration of the docs. + run: make -C docs cleanall html SPHINXBUILD=true + + - name: Compare the generated docs with the version committed to git + run: git diff --exit-code From eeb6a873b4ef65f3d4ada0977504696c8a2e30ce Mon Sep 17 00:00:00 2001 From: Lucas Hoffmann Date: Tue, 13 Aug 2024 23:28:29 +0200 Subject: [PATCH 2/2] Fake install alot in ci to check generated docs --- .github/workflows/check.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index b91d3ebc8..4083f9f52 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -57,6 +57,16 @@ jobs: - name: Set up Python uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Remove and mock problematic dependencies + run: | + sed -i '/gpg/d;/notmuch2/d' pyproject.toml + touch gpg.py + echo NullPointerError = NotmuchError = None > notmuch2.py + pip install . + git checkout pyproject.toml - name: Regenerate all generated docs # We run "true" instead of "sphinx-build" to speed things up as we are