Skip to content

ci: add centralized docs drift check - #3200

Merged
chernser merged 1 commit into
mainfrom
joe/docs-drift-check
Oct 12, 2026
Merged

chernser merged 1 commit into
mainfrom
joe/docs-drift-check

Conversation

@joe-clickhouse

Copy link
Copy Markdown
Contributor

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-docs label 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 current and legacy clients, JDBC, R2DBC, shared types, packaging, examples, and docs/features.md, with particular attention to formats, resource lifetimes, conversions, and optional dependencies. We can update or change it at any time, before or after this PR merges.

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.

This changes CI only. Java APIs and runtime behavior stay unchanged.

Checklist

@chernser
chernser merged commit 3f0cf8c into main Oct 12, 2026
8 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CI] Add centralized docs-drift checks

2 participants