Skip to content

test: Fix silent swallowing of unexpected subp error #690

test: Fix silent swallowing of unexpected subp error

test: Fix silent swallowing of unexpected subp error #690

Workflow file for this run

name: linkcheck in CI
on:
push:
branches:
- main
pull_request: {}
workflow_dispatch:
inputs:
failOnError:
description: 'Fail job on link check error'
required: false
default: 'false'
jobs:
linkcheck:
runs-on: ubuntu-22.04
continue-on-error: ${{ !(github.event_name == 'workflow_dispatch' && github.event.inputs.failOnError == 'true') }}
steps:
- name: Checkout Repository
uses: actions/[email protected]
- name: "Install Python 3.10"
uses: actions/setup-python@v4
with:
python-version: '3.10.8'
- name: Install tox
run: pip install tox
- name: Run Sphinx linkcheck
run: tox -e linkcheck | tee output.txt
- name: Check for broken links below threshold
run: |
broken_count=$(grep -c "broken" output.txt)
if [[ $broken_count -ge 6 ]]; then
echo "Too many broken links detected: $broken_count"
broken_matches=$(grep "broken" output.txt)
echo "Broken links \n$broken_matches"
exit 1
else
echo "Number of broken links is below threshold: $broken_count"
fi