GitHub is moving the ubuntu-latest label from Ubuntu 24.04 to 26.04 between October 19 and November 19, 2026 (actions/runner-images#14748). Pin every ubuntu-latest job to ubuntu-26.04 so the switch does not change the toolchain under our jobs, and so the behaviour does not depend on when GitHub reaches our runs. Jobs pinned to ubuntu-24.04 and ubuntu-24.04-arm are unchanged. Signed-off-by: Niels Lohmann <mail@nlohmann.me>
47 lines
1.2 KiB
YAML
47 lines
1.2 KiB
YAML
name: Check documentation links
|
|
|
|
# check the links of the documentation weekly; external links break without any change in this repository
|
|
on:
|
|
schedule:
|
|
- cron: '17 4 * * 1'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
check_docs_links:
|
|
if: github.repository == 'nlohmann/json'
|
|
runs-on: ubuntu-26.04
|
|
timeout-minutes: 30
|
|
steps:
|
|
- name: Harden Runner
|
|
uses: step-security/harden-runner@dc2769abcc0fcfbadfc1df54081c1608579ef6b2 # v2.22.2
|
|
with:
|
|
egress-policy: audit
|
|
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install virtual environment
|
|
run: make install_venv -C docs/mkdocs
|
|
|
|
- name: Check links
|
|
shell: bash # adds -o pipefail, so tee does not hide the exit code
|
|
run: make link_check -C docs/mkdocs 2>&1 | tee link_check.log
|
|
|
|
- name: Summarize broken links
|
|
if: failure()
|
|
run: |
|
|
{
|
|
echo '### Broken documentation links'
|
|
echo '```'
|
|
grep 'invalid url' link_check.log || true
|
|
echo '```'
|
|
} >> "$GITHUB_STEP_SUMMARY"
|