Repository navigation
ci: add centralized docs drift check - #1212
Merged
Merged
Conversation
kavirajk
approved these changes
Oct 21, 2026
kavirajk
left a comment
kavirajk
left a comment
Contributor
There was a problem hiding this comment.
LGTM. thanks @joe-clickhouse
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
Adds the shared docs-drift check already used by clickhouse-connect, dbt-clickhouse, and clickhouse-go. It reviews PR changes against this repo's docs and maintains an advisory
needs-docslabel and one sticky comment. A later docs fix clears the label and marks the comment resolved.The custom agent definition is a solid first attempt based on the repo's current docs and public APIs. It covers the README, public Go docs, and documented examples for the client, pool, block streaming, query parameters, column types, Native dumps, compression, authentication, and telemetry. The website comparison in clickhouse-go stays outside this checker's scope. We can update or change the definition at any time, before or after this PR merges.
This repo needs access to the shared Workflow Authentication App and the
WORKFLOW_AUTH_PUBLIC_APP_IDandWORKFLOW_AUTH_PUBLIC_PRIVATE_KEYsecrets before the check can run.Automatic checks skip fork and Dependabot PRs. Maintainers can check reviewed PRs manually. The worker reads the agent definition from the trusted PR base, so this will start taking effect after merge.