diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ecd7c971c..9105fb01b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -6,6 +6,8 @@ name: docs on: push: + tags: + - '[0-9]+.[0-9]+.[0-9]+' pull_request: branches: - main @@ -14,14 +16,37 @@ on: - docs/** - CHANGELOG.rst - README.md + workflow_dispatch: + inputs: + tag: + required: true jobs: - docs: + + build: runs-on: ubuntu-latest steps: - uses: actions/setup-python@v4 with: python-version: '3.11' + - run: echo ${{ github.event.push.tag || github.event.inputs.tag }} - uses: actions/checkout@v3 + with: + ref: ${{ github.event.push.tag || github.event.inputs.tag }} - run: python -m pip install .[docs] - run: python -m sphinx docs/ build/docs/ + - uses: actions/upload-pages-artifact@v1 + with: + path: build/docs/html + + deploy: + needs: build + permissions: + pages: write + id-token: write + environment: + name: github-pages + runs-on: ubuntu-latest + if: ${{ github.event.push.tag || github.event.inputs.tag }} + steps: + - uses: actions/deploy-pages@v1