Skip to content
Documentation checks

Suppress most cli errors, but still warn if we get too many #179

Sign in to view logs

Suppress most cli errors, but still warn if we get too many

Suppress most cli errors, but still warn if we get too many #179

Workflow file for this run

.github/workflows/documentation_checks.yml at 7cd7fe0
name: Documentation checks
on:
pull_request:
branches:
- main
paths:
- 'docs/**'
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
spellcheck:
name: Spelling check
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Aspell
run: |
sudo apt-get install aspell aspell-en
- name: Install the doc framework
working-directory: docs/
run: |
make install
- name: Build docs and run spelling checker
working-directory: docs/
run: |
make spelling
woke:
name: Inclusive language check
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install the doc framework
working-directory: docs/
run: |
make install
- name: Run Woke
working-directory: docs/
run: |
make woke
linkcheck:
name: Link check
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install the doc framework
working-directory: docs/
run: |
make install
- name: Run linkchecker
working-directory: docs/
run: |
make linkcheck