Skip to content
Automatic documentation checks

Unique validator for packaging metadata (BugFix) #147

Sign in to view logs

Unique validator for packaging metadata (BugFix)

Unique validator for packaging metadata (BugFix) #147

Workflow file for this run

.github/workflows/documentation-check.yml at 71804cb
name: Automatic documentation checks
on:
pull_request:
paths:
- 'docs/**'
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
spellcheck:
name: Spelling check
runs-on: [self-hosted, linux, large]
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install Aspell
run: |
sudo apt update -qq
sudo apt install -qq -y aspell aspell-en
- name: Install the doc framework
working-directory: docs/
run: |
sudo apt install -y -qq python3-venv
make install
- name: Build docs and run spelling checker
working-directory: docs/
run: |
make spelling
woke:
name: Inclusive language check
runs-on: [self-hosted, linux, large]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: woke
uses: get-woke/woke-action@v0
with:
# Cause the check to fail on any broke rules
fail-on-error: true
workdir: docs/
woke-args: "*.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"
linkcheck:
name: Link check
runs-on: [self-hosted, linux, large]
defaults:
run:
working-directory: docs
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install the doc framework
working-directory: docs/
run: |
sudo apt install -y -qq python3-venv
make install
- name: Run linkchecker
working-directory: docs/
run: |
make linkcheck