Skip to content

Markdown lint

Markdown lint #1840

name: Markdown lint
on:
schedule:
- cron: '5 8 * * *'
workflow_dispatch:
pull_request:
paths:
- '**.md'
- 'book/**'
jobs:
markdown-lint:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- name: Lint
run: make markdown-lint
- name: Spell check
run: pip install codespell && make -C book codespell
- id: setup-chrome
uses: browser-actions/setup-chrome@v2
with:
chrome-version: stable
- name: Point Puppeteer at the installed Chrome
run: echo "PUPPETEER_EXECUTABLE_PATH=${{ steps.setup-chrome.outputs.chrome-path }}" >> "$GITHUB_ENV"
- uses: umbrelladocs/action-linkspector@v1
with:
fail_on_error: true
filter_mode: nofilter
- name: Inform Slack users of check failures
uses: tiloio/slack-webhook-action@v1.1.2
if: failure() && github.ref_name == 'main'
with:
slack_web_hook_url: ${{ secrets.SLACK_WEBHOOK_BRIMLABS_DOCS }}
slack_json: |
{
"username": "markdown-lint",
"text": "Markdown lint check failed: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
}