Skip to content
Draft
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
46 changes: 46 additions & 0 deletions .github/workflows/docs_verify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 'Verify Docs'

on:
pull_request:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/docs_verify.yml'
push:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/docs_verify.yml'

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to update this to v5

Suggested change
uses: actions/checkout@v4
uses: actions/checkout@v5


# 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
Loading