Skip to content

linkcheck

linkcheck #2828

Workflow file for this run

name: linkcheck
on:
pull_request:
paths:
- docs/conf.py
- .github/workflows/linkcheck.yml
schedule:
# Run once a week on Fridays
- cron: "0 0 * * FRI"
permissions:
contents: read
env:
CARGO_INCREMENTAL: 0
jobs:
docs-linkcheck:
runs-on: ubuntu-latest
name: "linkcheck"
timeout-minutes: 10
steps:
- uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
with:
persist-credentials: false
- name: Setup python
id: setup-python
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
with:
python-version: 3.11
- name: Cache rust and pip
uses: ./.github/actions/cache
timeout-minutes: 2
with:
# This creates the same key as the docs job (as long as they have the same
# python version)
key: 3.11-${{ steps.setup-python.outputs.python-version }}
- run: python -m pip install -c ci-constraints-requirements.txt nox
- name: Build nox environment
run: |
nox -v --install-only -s docs-linkcheck
env:
CARGO_TARGET_DIR: ${{ format('{0}/src/rust/target/', github.workspace) }}
- name: linkcheck
run: nox --no-install -s docs-linkcheck -- --color=yes