From 8148c0d99d4475dd6ad83478480713b52aa91c9c Mon Sep 17 00:00:00 2001 From: Paul Wise Date: Sat, 18 Mar 2023 09:51:13 +0800 Subject: [PATCH] Dump the changes after building docs to the logs So that it is possible to update a docs PR using the workflow log rather than having to install docs deps and build the docs locally. Building the docs takes too long locally so I am doing it in CI. --- .github/workflows/linters.yml | 3 --- .github/workflows/tests.yml | 13 +++++++++++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml index 05693fd252..3f736ff951 100644 --- a/.github/workflows/linters.yml +++ b/.github/workflows/linters.yml @@ -27,6 +27,3 @@ jobs: # - name: Run flake8 linter (documentation) # run: flake8 --ignore E202,E402,E302,E305,F821 --max-line-length 120 --filename '*.py,*.rst' docs - - - name: Check Sphinx Gallery cache - run: python docs/src/check_gallery.py diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 4dd9b6b25a..8d1cad4c0e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -51,6 +51,19 @@ jobs: run: | python setup.py build_ext --inplace make -C docs/src clean html + git add . + git commit -m 'Import documentation changes' + git format-patch @^ + git bundle create fix-links.bundle @^...@ + + - name: Upload patch/bundle as artifacts + if: always() + uses: actions/upload-artifact@v3 + with: + name: fix-links-get-patch + path: | + *.patch + *.bundle # # FIXME: do we want to store the built documentation somewhere, or is # knowing that the docs built successfully enough?