From dd247629544ec71c18301439a2361381be0e8c04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Kr=C3=A1tk=C3=BD?= Date: Thu, 19 Oct 2023 15:55:18 +0200 Subject: [PATCH] Add docs checks to GH workflows: * spellcheck * linkcheck * inclusive-language check --- .github/workflows/automatic-doc-checks.yml | 22 ++++++++++++++++++++++ doc/Makefile | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/automatic-doc-checks.yml diff --git a/.github/workflows/automatic-doc-checks.yml b/.github/workflows/automatic-doc-checks.yml new file mode 100644 index 00000000..7a94df6e --- /dev/null +++ b/.github/workflows/automatic-doc-checks.yml @@ -0,0 +1,22 @@ +name: Main Documentation Checks + +on: + pull_request: + paths: + - 'doc/**' + push: + paths: + - 'doc/**' + workflow_dispatch: + paths: + - 'doc/**' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + documentation-checks: + uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main + with: + working-directory: 'doc' diff --git a/doc/Makefile b/doc/Makefile index 070b39da..adbfb8a2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -55,7 +55,7 @@ linkcheck: . $(VENV) ; $(SPHINXBUILD) -c . -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" woke: - type woke >/dev/null 2>&1 || { sudo snap install woke; exit 1; } + type woke >/dev/null 2>&1 || { sudo snap install woke || exit 1; } woke *.rst **/*.rst -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml .PHONY: help Makefile