Update checks workflow to fix the broken link issue-3152 #916
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: "run-linting-checks" | |
on: | |
pull_request: | |
branches: [main, release] | |
jobs: | |
check-docs: | |
name: runner / check docs | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install uv | |
uses: astral-sh/setup-uv@v6 | |
- name: Ensure docs build cleanly | |
run: O="-a -E -n -W --keep-going" make docs | |
run-pylint: | |
name: runner / pylint | |
permissions: write-all | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: dciborow/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
reporter: github-pr-review | |
level: warning | |
glob_pattern: "**/*.py" | |
filter_mode: "file" | |
misspell: | |
name: runner / misspell | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Highlight any misspellings in changes | |
uses: reviewdog/action-misspell@v1 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
locale: "US" | |
uv-lock: | |
name: runner / uv-lock | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: astral-sh/setup-uv@v6 | |
- name: Ensure uv lockfile is up to date | |
run: uv lock --check | |
broken-links: | |
name: runner / broken link check | |
runs-on: ubuntu-latest | |
needs: check-docs | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Install lychee | |
uses: lycheeverse/[email protected] | |
id: lychee | |
- name: Run lychee link checker | |
run: | | |
mkdir -p lychee | |
lychee --verbose --no-progress --exclude-mail --timeout 20 . > lychee/out.md | |
- name: Upload link check report | |
uses: actions/upload-artifact@v4 | |
with: | |
name: lychee-report | |
path: ./lychee/out.md |