From 05dfa21114d32d892eb1f45266db459d9e396f4a Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Mon, 5 Oct 2026 10:29:14 -0700 Subject: [PATCH 1/5] ci: replace documentation-workflows calls --- .github/workflows/automatic-doc-checks.yml | 54 +++++++++++++++++----- 1 file changed, 42 insertions(+), 12 deletions(-) diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml index 66c917d5..7b94d38d 100644 --- a/.github/workflows/automatic-doc-checks.yml +++ b/.github/workflows/automatic-doc-checks.yml @@ -1,23 +1,53 @@ -# -name: Automatic doc checks +name: Documentation checks on: push: - branches: [ main ] + branches: + - main pull_request: paths: - - 'docs/**' # Only run on changes to the docs directory + - "docs/**" - workflow_dispatch: - # Manual trigger +env: + DOCS_DIR: "docs" + PYTHON_VERSION: "3.10" + +permissions: + contents: read concurrency: - group: ${{ github.workflow }}-${{ github.ref }} + group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }} cancel-in-progress: true jobs: - documentation-checks: - uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main - with: - working-directory: "docs" - fetch-depth: 0 + checks: + name: ${{ matrix.check.name }} + runs-on: ubuntu-24.04 + strategy: + fail-fast: false + matrix: + check: + - name: Spelling check + target: spelling + - name: Link check + target: linkcheck + - name: Inclusive language check + target: woke + defaults: + run: + working-directory: ${{ env.DOCS_DIR }} + steps: + - name: Checkout + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0 + with: + python-version: ${{ env.PYTHON_VERSION }} + cache: "pip" + cache-dependency-path: ${{ env.DOCS_DIR }}/requirements.txt + + - name: Run check + run: make ${{ matrix.check.target }} From 35fd8585e5366b17adb38c88f374ab62d233bcbf Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Thu, 8 Oct 2026 16:32:53 -0700 Subject: [PATCH 2/5] ci: rename workflow --- .github/workflows/automatic-doc-checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml index 7b94d38d..3fc60b69 100644 --- a/.github/workflows/automatic-doc-checks.yml +++ b/.github/workflows/automatic-doc-checks.yml @@ -1,4 +1,4 @@ -name: Documentation checks +name: Documentation on: push: From bd23ab5128842316ac83ce2e655764fa458bc871 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 9 Oct 2026 09:19:25 -0700 Subject: [PATCH 3/5] docs: update supporting docs --- CHANGELOG.md | 3 ++- CONTRIBUTING.md | 15 +++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51b23a43..66ce8561 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,9 +14,10 @@ * `docs/conf.py` [#610](https://github.com/canonical/sphinx-stack/pull/610) * `docs/Makefile` [#605](https://github.com/canonical/sphinx-stack/pull/605), [#610](https://github.com/canonical/sphinx-stack/pull/610), [#627](https://github.com/canonical/sphinx-stack/pull/627), [#628](https://github.com/canonical/sphinx-stack/pull/628) * `README.md` [#603](https://github.com/canonical/sphinx-stack/pull/603) +* `.github/workflows/automatic-doc-checks.yml` [#642](https://github.com/canonical/sphinx-stack/pull/642) * `.github/workflows/cla-check.yml` [#606](https://github.com/canonical/sphinx-stack/pull/606) * `.github/workflows/check-removed-urls.yml` [#612](https://github.com/canonical/sphinx-stack/pull/#612) -* `CONTRIBUTING.md` [#632](https://github.com/canonical/sphinx-stack/pull/632) +* `CONTRIBUTING.md` [#632](https://github.com/canonical/sphinx-stack/pull/632), [#642](https://github.com/canonical/sphinx-stack/pull/642) ## 2.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62d01a34..6c1d0174 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -349,17 +349,16 @@ branches should ensure they have signed the CLA before their changes are merged ### Checks on changes to `docs/` only -- Markdown style check: Runs `pymarkdownlnt` on Markdown files -- Automatic documentation checks: Runs upstream documentation workflow checks. The - project uses - [canonical/documentation-workflows](https://github.com/canonical/documentation-workflows) - for automatic documentation checks. To modify this part of CI behavior, pass inputs to - upstream workflows rather than creating or customizing local copies. +- Spelling check: Checks spelling in the documentation with Vale +- Link check: Check external links in the documentation with the Sphinx `linkcheck` + builder +- Inclusive language check: Ensure the documentation uses inclusive language with Vale +- Markdown style check: Lint the Markdown source with `pymarkdownlnt` ### Optional checks (allowed to fail) -- Style guide check (`vale`): Checks compliance with the Canonical style guide -- Accessibility check (`pa11y`): Checks accessibility of generated HTML +- Style guide check: Checks compliance with the Canonical style guide with Vale +- Accessibility check: Checks the accessibility of generated HTML with Pa11y ## Review process From a168397b90d69aa638643acd1aa6ad8ee6054c39 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 9 Oct 2026 09:22:08 -0700 Subject: [PATCH 4/5] docs: remove CONTRIBUTING.md from changelog --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66ce8561..32684473 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,7 +17,6 @@ * `.github/workflows/automatic-doc-checks.yml` [#642](https://github.com/canonical/sphinx-stack/pull/642) * `.github/workflows/cla-check.yml` [#606](https://github.com/canonical/sphinx-stack/pull/606) * `.github/workflows/check-removed-urls.yml` [#612](https://github.com/canonical/sphinx-stack/pull/#612) -* `CONTRIBUTING.md` [#632](https://github.com/canonical/sphinx-stack/pull/632), [#642](https://github.com/canonical/sphinx-stack/pull/642) ## 2.0 From a2bff8ab50306eef51a9901eecc062b131f9ffa8 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Thu, 15 Oct 2026 10:19:08 -0700 Subject: [PATCH 5/5] docs: remove changelog entry for project-specific file --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 32684473..6e0089f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,6 @@ * Update link to documentation in README * Exclude `_build` dir when linting Markdown * Skip pa11y installation if it is already present -* Update `CONTRIBUTING.md` to include versioning and breaking changes policy ### Changed