From aa421100dc19923632cdce70d681484066727dbf Mon Sep 17 00:00:00 2001 From: Matt Wozniski Date: Tue, 1 Aug 2023 17:15:10 -0400 Subject: [PATCH] ci: Automatically publish docs for new releases On each new release, automatically build our docs and publish them to GitHub Pages. The docs are also built by our linting workflow, but we don't attempt to reuse that build here, because the linting build includes a phony 99.99 version number that it uses for exercising the news fragments in the news/ directory. Signed-off-by: Matt Wozniski --- .github/workflows/build_wheels.yml | 31 ++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/.github/workflows/build_wheels.yml b/.github/workflows/build_wheels.yml index aec76ee0f6..73c0614ece 100644 --- a/.github/workflows/build_wheels.yml +++ b/.github/workflows/build_wheels.yml @@ -156,3 +156,34 @@ jobs: with: skip_existing: true password: ${{ secrets.PYPI_PASSWORD }} + + publish_docs: + name: Publish docs + runs-on: ubuntu-latest + if: github.event_name == 'release' && github.event.action == 'published' + permissions: + contents: write + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + - name: Set up dependencies + run: | + sudo apt-get update + sudo apt-get install -qy clang-format npm libunwind-dev liblz4-dev pkg-config + - name: Install Python dependencies + run: | + python3 -m pip install -r requirements-extra.txt + - name: Install Package + run: | + python3 -m pip install -e . + - name: Build docs + run: | + make docs + - name: Publish docs to GitHub Pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: docs/_build/html + single-commit: true