Skip to content

build(deps): bump github/codeql-action from 3.26.6 to 3.26.7 (#824) #518

build(deps): bump github/codeql-action from 3.26.6 to 3.26.7 (#824)

build(deps): bump github/codeql-action from 3.26.6 to 3.26.7 (#824) #518

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.7 # v3.3.0
- uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
with:
# NOTE: We use 3.10+ typing syntax via future, which pdoc only
# understands if it's actually run with Python 3.10 or newer.
python-version: ">= 3.10"
cache: "pip"
cache-dependency-path: pyproject.toml
- name: setup
run: |
make dev PIP_AUDIT_EXTRA=doc
- name: build docs
run: |
make doc
- name: upload docs artifact
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
with:
path: ./html/
# This is copied from the official `pdoc` example:
# https://github.com/mitmproxy/pdoc/blob/main/.github/workflows/docs.yml
#
# Deploy the artifact to GitHub pages.
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
# NOTE: Needed to push to the repository.
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5