Update .github/workflows/docs.yaml #32
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build & deploy docs | |
on: | |
push: | |
pull_request: | |
jobs: | |
build-docs: | |
name: Build Docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v2 | |
- name: Setup python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: "3.10" | |
architecture: x64 | |
- name: Install dev requirements | |
working-directory: ./docs | |
run: pip install -r requirements.txt | |
- name: Generate docs | |
working-directory: ./docs | |
run: | | |
git fetch --unshallow --tags | |
git branch -r | |
echo exit code $? | |
git tag --list | |
make build | |
cp _redirect/index.html _build/index.html | |
- name: Upload docs artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs-html | |
path: ./docs/_build | |
check-secrets: | |
name: Check secrets | |
runs-on: ubuntu-latest | |
outputs: | |
trigger-deploy: ${{ steps.trigger-deploy.outputs.defined }} | |
steps: | |
- id: trigger-deploy | |
env: | |
REPO_NAME: ${{ secrets.REPO_NAME }} | |
BRANCH_REF: ${{ secrets.BRANCH_REF }} | |
if: "${{ github.repository == env.REPO_NAME && github.ref == env.BRANCH_REF }}" | |
run: echo "defined=true" >> "$GITHUB_OUTPUT" | |
deploy-docs: | |
name: Deploy Docs | |
runs-on: ubuntu-latest | |
needs: [check-secrets, build-docs] | |
if: needs.check-secrets.outputs.trigger-deploy == 'true' | |
steps: | |
- name: Download docs artifact | |
uses: actions/download-artifact@v4 | |
with: | |
name: docs-html | |
path: ./docs/_build | |
- name: Deploy to gh-pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/_build |