From 8490ea67faaf402db8af8df611e0d01871ad28c4 Mon Sep 17 00:00:00 2001 From: timbretimber <105982513+timbretimber@users.noreply.github.com> Date: Mon, 3 Nov 2025 20:51:18 -0700 Subject: [PATCH 1/4] ci: only run docs action when files in docs folder changed Signed-off-by: timbretimber <105982513+timbretimber@users.noreply.github.com> --- .github/workflows/builds.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index be0ea25a..22616dc6 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -1,7 +1,11 @@ name: Builds on: - - push - - pull_request + push: + paths: + - docs/** + pull_request: + paths: + - docs/** permissions: contents: read From 63fe384aca6b4dd25aa309dbd55f5b44c8c7047e Mon Sep 17 00:00:00 2001 From: timbretimber <105982513+timbretimber@users.noreply.github.com> Date: Mon, 3 Nov 2025 21:23:43 -0700 Subject: [PATCH 2/4] ci: split up code and documentation testing workflows * don't run docs tests when only code changes * don't run code tests when only docs change Signed-off-by: timbretimber <105982513+timbretimber@users.noreply.github.com> --- .github/workflows/docs-test.yml | 48 +++++++++++++++++++++++++++++++++ .github/workflows/tests.yml | 46 ++++++++----------------------- 2 files changed, 59 insertions(+), 35 deletions(-) create mode 100644 .github/workflows/docs-test.yml diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml new file mode 100644 index 00000000..e33ed753 --- /dev/null +++ b/.github/workflows/docs-test.yml @@ -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 diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index fd9f2943..d0f5e402 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -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 @@ -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 From af4fb32f78b1aaa63eb161d27944d8698f414c9f Mon Sep 17 00:00:00 2001 From: timbretimber <105982513+timbretimber@users.noreply.github.com> Date: Mon, 3 Nov 2025 21:24:21 -0700 Subject: [PATCH 3/4] ci: also rebuild docs if sphinx config changes Signed-off-by: timbretimber <105982513+timbretimber@users.noreply.github.com> --- .github/workflows/{builds.yml => build-docs.yml} | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) rename .github/workflows/{builds.yml => build-docs.yml} (90%) diff --git a/.github/workflows/builds.yml b/.github/workflows/build-docs.yml similarity index 90% rename from .github/workflows/builds.yml rename to .github/workflows/build-docs.yml index 22616dc6..4ebbec4b 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/build-docs.yml @@ -1,11 +1,13 @@ -name: Builds +name: Build documentation on: push: paths: - docs/** + - .sphinx/** pull_request: paths: - docs/** + - .sphinx/** permissions: contents: read From 752d7a07a61e82dda3ec2dc634e42d6d2cfa80eb Mon Sep 17 00:00:00 2001 From: timbretimber <105982513+timbretimber@users.noreply.github.com> Date: Mon, 3 Nov 2025 22:10:02 -0700 Subject: [PATCH 4/4] ci: rename docs-test.yml to test-docs.yml to be more consistent Signed-off-by: timbretimber <105982513+timbretimber@users.noreply.github.com> --- .github/workflows/{docs-test.yml => test-docs.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{docs-test.yml => test-docs.yml} (100%) diff --git a/.github/workflows/docs-test.yml b/.github/workflows/test-docs.yml similarity index 100% rename from .github/workflows/docs-test.yml rename to .github/workflows/test-docs.yml