From 3ad9e86ba11f10e356eae401489fb0803388b202 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Thu, 4 Jun 2026 17:22:32 +0200 Subject: [PATCH 1/2] Add docs verification workflow Verify this repo's docs/ as a slice of the aggregated ClickHouse docs site. The job runs inside the clickhouse/docs-builder image, where git, python3 and mint are all present, so nothing is installed and this repo vendors no scripts. It fetches the check driver from ClickHouse/ClickHouse at runtime; the driver shallow/sparse-clones the aggregator docs (bringing ci/jobs/scripts/docs along for free), replaces the Python client folder with this repo's docs/ -- wiping it first so deletions and renames are reflected -- and runs the checks (mint validate + mint broken-links) from the docs root. A non-zero exit fails the job, so a green run means every check passed. Co-Authored-By: Claude Opus 4.8 (1M context) --- .github/workflows/docs_verify.yml | 44 +++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/docs_verify.yml diff --git a/.github/workflows/docs_verify.yml b/.github/workflows/docs_verify.yml new file mode 100644 index 00000000..4dda0bc2 --- /dev/null +++ b/.github/workflows/docs_verify.yml @@ -0,0 +1,44 @@ +name: 'Verify Docs' + +on: + pull_request: + branches: + - main + paths: + - 'docs/**' + push: + branches: + - main + paths: + - 'docs/**' + +jobs: + verify: + runs-on: ubuntu-latest + name: Mintlify checks + # Run inside the docs image so every dependency (git, python3, mint, node) + # is present -- nothing is installed, and this repo vendors no scripts. + container: + image: clickhouse/docs-builder + steps: + - name: Checkout clickhouse-connect + uses: actions/checkout@v4 + + # Fetch the check driver from ClickHouse/ClickHouse rather than vendoring + # it. The driver shallow/sparse-clones the aggregator docs plus its CI + # scripts (ci/jobs/scripts/docs), so any check scripts come along for free. + - name: Fetch the docs check driver + run: | + curl -fsSL -o /tmp/mintlify_docs_check.py \ + https://raw.githubusercontent.com/ClickHouse/ClickHouse/master/ci/jobs/scripts/docs/mintlify_docs_check.py + + # The driver clones the aggregator, replaces the Python client folder with + # this repo's docs/ (wiping it first, so deletions/renames are seen), and + # runs the checks (mint validate + mint broken-links) from the docs root. + # It exits non-zero if any check fails, so a green step means all passed. + - name: Run Mintlify docs checks + run: | + python3 /tmp/mintlify_docs_check.py \ + --repo https://github.com/ClickHouse/ClickHouse.git \ + --ref master \ + --replace docs:integrations/language-clients/python \ No newline at end of file From c98bdfec6d9f897e38f7873544ff4082998daf91 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Wed, 10 Jun 2026 10:52:38 +0200 Subject: [PATCH 2/2] Trigger docs check on workflow changes; add trailing newline Changes to the workflow itself should also run the check, so add the workflow file to the paths filter of both triggers. Co-Authored-By: Claude Fable 5 --- .github/workflows/docs_verify.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs_verify.yml b/.github/workflows/docs_verify.yml index 4dda0bc2..b0ef0731 100644 --- a/.github/workflows/docs_verify.yml +++ b/.github/workflows/docs_verify.yml @@ -6,11 +6,13 @@ on: - main paths: - 'docs/**' + - '.github/workflows/docs_verify.yml' push: branches: - main paths: - 'docs/**' + - '.github/workflows/docs_verify.yml' jobs: verify: @@ -41,4 +43,4 @@ jobs: python3 /tmp/mintlify_docs_check.py \ --repo https://github.com/ClickHouse/ClickHouse.git \ --ref master \ - --replace docs:integrations/language-clients/python \ No newline at end of file + --replace docs:integrations/language-clients/python