Use linkspector for markdown link checking and fix the broken links it found #410
This file contains 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: Markdown lint | |
on: | |
schedule: | |
- cron: '5 8 * * *' | |
workflow_dispatch: | |
pull_request: | |
paths: | |
- '**.md' | |
jobs: | |
markdown-link: | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Lint | |
run: make markdown-lint | |
- uses: umbrelladocs/action-linkspector@v1 | |
with: | |
fail_on_error: true | |
filter_mode: nofilter | |
- name: Inform Slack users of link check failures | |
uses: tiloio/[email protected] | |
if: failure() && github.ref_name == 'main' | |
with: | |
slack_web_hook_url: ${{ secrets.SLACK_WEBHOOK_BRIMLABS_DOCS }} | |
slack_json: | | |
{ | |
"username": "markdown-link", | |
"text": "Markdown link check failed: ${{ github.event.workflow_run.html_url }}" | |
} |