Bump tornado from 6.4 to 6.4.1 in /docs #29
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: Documentation | |
on: | |
pull_request: | |
paths: | |
- 'docs/**' | |
- '.github/workflows/docs.yaml' | |
push: | |
branches: | |
- develop | |
paths: | |
- 'docs/**' | |
- '**.py' | |
- '.github/workflows/docs.yaml' | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: ammaraskar/[email protected] | |
with: | |
docs-folder: "docs/" | |
build-command: make html dirhtml | |
- name: Setup Python | |
uses: actions/[email protected] | |
with: | |
python-version: 3.11 | |
- name: Install Python dependencies | |
run: pip install -qr cli/requirements.txt | |
- name: Generate coverage report | |
run: | | |
cd cli | |
coverage run -m unittest discover | |
coverage-badge -o coverage.svg | |
cd .. | |
sudo mv cli/coverage.svg docs/_build/dirhtml/_images/ | |
- uses: actions/upload-artifact@v3 | |
with: | |
name: Documentation | |
path: docs/_build/html/ | |
- uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/_build/dirhtml/ | |
# Deployment job | |
deploy: | |
if: github.ref == 'refs/heads/develop' | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: docs | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |