Skip to content

Document clang-tidy flow and drop legacy CI job#12175

Merged
RAMitchell merged 1 commit into
dmlc:masterfrom
RAMitchell:codex/clang-tidy-docs-cleanup
Apr 21, 2026
Merged

Document clang-tidy flow and drop legacy CI job#12175
RAMitchell merged 1 commit into
dmlc:masterfrom
RAMitchell:codex/clang-tidy-docs-cleanup

Conversation

@RAMitchell

Copy link
Copy Markdown
Member

Summary

Update the contributor documentation to use the clang-CUDA compile-database clang-tidy flow and remove the legacy CI job that still ran the old wrapper script.

What changed

  • document ops/pipeline/run-clang-tidy-clang-cuda.sh as the local clang-tidy entry point
  • show how to scope runs with XGBOOST_TIDY_FILES, XGBOOST_TIDY_CHECKS, and helper arguments
  • remove the old CI job and keep the compile-database path as the canonical clang-tidy job

Testing

  • pre-commit run --files .github/workflows/lint.yml doc/contrib/coding_guide.rst

@RAMitchell RAMitchell requested a review from Copilot April 20, 2026 14:59
@RAMitchell RAMitchell marked this pull request as ready for review April 20, 2026 15:00

Copilot AI left a comment

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.

Pull request overview

Updates XGBoost contributor documentation and CI to standardize on the clang-generated CUDA compile database flow for clang-tidy, removing the legacy CI job that ran the older wrapper.

Changes:

  • Document ops/pipeline/run-clang-tidy-clang-cuda.sh as the recommended local clang-tidy entry point, including scoping via env vars and CLI flags.
  • Remove the legacy clang-tidy CI job and keep the compile-database-based job as the canonical workflow path.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
doc/contrib/coding_guide.rst Replaces local clang-tidy instructions with the clang-CUDA compile DB helper and adds usage examples/configuration knobs.
.github/workflows/lint.yml Drops the legacy clang-tidy CI job and retains the compile DB clang-tidy job under the clang-tidy job key.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread doc/contrib/coding_guide.rst
Comment thread doc/contrib/coding_guide.rst
@RAMitchell RAMitchell requested a review from trivialfis April 21, 2026 08:13
@RAMitchell RAMitchell merged commit 1c9b32a into dmlc:master Apr 21, 2026
86 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.

3 participants