Skip to content

Commit

Permalink
github: run linkcheck in workflow
Browse files Browse the repository at this point in the history
Problem: our links have become stale due to not
enforcing sphinx's linkcheck option in CI.

Add that back in.

Fixes #284
  • Loading branch information
wihobbs committed Oct 24, 2024
1 parent a01a440 commit a2d78e3
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,20 @@ jobs:
echo "Testing that you built the auto-examples, if this fails run flux start make html locally."
python .github/scripts/check_diff.py /tmp/auto_examples ./auto_examples
spelling:
spell-and-linkcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: install dependencies
run: >-
sudo apt-get update -y &&
sudo apt-get install -y python3-pip &&
sudo apt-get install -y enchant python3-pip &&
sudo pip3 install --upgrade -r ./requirements.txt
- name: Check Spelling
uses: crate-ci/typos@7ad296c72fa8265059cc03d1eda562fbdfcd6df2 # v1.9.0
with:
files: "*.rst */*.rst */*/*.rst"

- name: make linkcheck
run: make linkcheck

0 comments on commit a2d78e3

Please sign in to comment.