[WIP] add Mintlify docs verification workflow#778
Draft
Blargian wants to merge 2 commits into
Draft
Conversation
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) <noreply@anthropic.com>
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 <noreply@anthropic.com>
| image: clickhouse/docs-builder | ||
| steps: | ||
| - name: Checkout clickhouse-connect | ||
| uses: actions/checkout@v4 |
Contributor
There was a problem hiding this comment.
We'll need to update this to v5
Suggested change
| uses: actions/checkout@v4 | |
| uses: actions/checkout@v5 |
Contributor
|
According to Claude: Status update after ClickHouse/ClickHouse#106258 merged today. I re-ran the failed Mintlify check and the workflow itself now works end to end. The driver downloads, splices this repo's docs into the aggregator, and runs both checks. The remaining failures are not problems with this workflow.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verify this repo's
docs/as a slice of the aggregated ClickHouse docs site over on ClickHouse/ClickHouse. The job runs inside the clickhouse/docs-builder image, where git, python3 and mint (mintlify CLI) 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 and any scripts needed to run the docs check, replaces the language client docs copy in the aggregator repo with this repo's
docs/(from the branch the docs check runs on) and runs the same checks that ClickHouse/ClickHouse docs check runs from the docs root. A non-zero exit fails the job.Requires:
Checklist
Delete items not relevant to your PR: