Docs: own and sync ClickHouse documentation#1929
Conversation
|
@kavirajk the docs verify workflow added here also uses lychee to check the links within the context of the entire docs site. Will need to exclude the newly added files from the existing link checker you have set up. |
| # Label on a merged PR in THIS repo that triggers the expedited path. | ||
| SYNC_LABEL: sync-docs | ||
| # Which releases trigger a sync: major (X.0.0), minor (X.Y.0), or all. | ||
| RELEASE_SCOPE: all |
There was a problem hiding this comment.
The header comment (line 9) states releases sync "major-only by default," but RELEASE_SCOPE is set to all, so every non-prerelease release triggers a sync attempt — a maintainer tuning cadence from the comment will be misled.
The empty-PR guard keeps this harmless in practice, so pick the intended default and make the two agree.
| RELEASE_SCOPE: all | |
| RELEASE_SCOPE: major |
| # 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 \ |
There was a problem hiding this comment.
This step curls a script from master and pipes it into python3, and the job runs in the untagged clickhouse/docs-builder (i.e. :latest) image — so upstream changes can silently break or alter CI, and the run is not reproducible.
- Pin the script to a commit SHA (
.../ClickHouse/<sha>/ci/jobs/scripts/docs/mintlify_docs_check.py) rather thanmaster. - Pin the container to a tag or digest.
- Add an explicit least-privilege
permissions: contents: readblock, since on thepush: maintrigger this executes remote code with whatever the repo's default token scope is.
🤖 Claude reviewMoves the Go client's public docs into The sync workflow is well-built for a Suggestions (non-blocking):
Blind spots:
Verdict: ✅ Approve Inline comments are attached to the relevant lines. This summary updates in place on re-review. |
Summary
Make
ClickHouse/clickhouse-gothe source of truth for its public ClickHouse documentation.ClickHouse/ClickHouse@21ed77718a5f454680497924d68e9f60a41e026cintodocs/, with trailing whitespace normalized.ClickHouse/ClickHousedocs PR after a release, manual dispatch, or merge carrying thesync-docslabel.The published URLs and aggregator path remain unchanged. Future content changes can be reviewed alongside the client implementation and then synchronized automatically.
After merge, maintainers should confirm the
sync-docslabel exists and the Workflow Auth GitHub App credentials are available to this repository.Validation
actionlintv1.7.7 and YAML parsing.git diff --checkpasses.