Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
name: Builds
name: Build documentation
on:
- push
- pull_request
push:
paths:
- docs/**
- .sphinx/**
pull_request:
paths:
- docs/**
- .sphinx/**

permissions:
contents: read
Expand Down
48 changes: 48 additions & 0 deletions .github/workflows/test-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Documentation tests
on:
push:
paths:
- "**.md"
- .sphinx/**
- doc/**
pull_request:
paths:
- "**.md"
- .sphinx/**
- doc/**

permissions:
contents: read

jobs:
documentation:
name: Documentation tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install dependencies
run: |
sudo apt-get install aspell aspell-en
sudo snap install mdl

- name: Run markdown linter
run: |
make doc-lint

- name: Run spell checker
run: |
make doc-spellcheck

- name: Run inclusive naming checker
uses: get-woke/woke-action@v0
with:
fail-on-error: true
woke-args: "*.md **/*.md -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"

- name: Run link checker
# This can fail intermittently due to external resources being unavailable.
continue-on-error: true
run: |
make doc-linkcheck
46 changes: 11 additions & 35 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
name: Tests
name: Code tests
on:
- push
- pull_request
push:
paths-ignore:
- "**.md"
- .sphinx/**
- doc/**
pull_request:
paths-ignore:
- "**.md"
- .sphinx/**
- doc/**

permissions:
contents: read
Expand Down Expand Up @@ -53,35 +61,3 @@ jobs:

- name: Unit tests (all)
run: make check

documentation:
name: Documentation tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install dependencies
run: |
sudo apt-get install aspell aspell-en
sudo snap install mdl

- name: Run markdown linter
run: |
make doc-lint

- name: Run spell checker
run: |
make doc-spellcheck

- name: Run inclusive naming checker
uses: get-woke/woke-action@v0
with:
fail-on-error: true
woke-args: "*.md **/*.md -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"

- name: Run link checker
# This can fail intermittently due to external resources being unavailable.
continue-on-error: true
run: |
make doc-linkcheck