ci: align pre-commit hooks and GitHub templates - #861
Conversation
Adopt the shared pre-commit baseline: two-line SPDX header, conventional commit message validation (commit-msg stage), and the centralized add-license / add-spdx-license hooks from developer_tools v0.2.0. Run pre-commit CI only on files modified by the PR, and roll out the standard issue templates and the simplified single PR template. TRI-1100
Legal's Copyright / License Header Guidance specifies the SPDX form without a comma after the year. TRI-1100
Human-readable type labels with enforced descriptions and colors. TRI-1100
github-actions
Bot
added
CI/CD
github-actions
Bot
added
the
chore
check-added-large-files, check-symlinks, and detect-private-key were deliberately configured on main; the baseline alignment must not drop them. (The top-level ^tensorrt_llm/ exclude covers the submodule, so the per-hook exclude from main is no longer needed.) TRI-1100
The add-license hook now fails when the LICENSE copyright year is stale. TRI-1100
Workflow files are license-processed again (only templates excluded); refresh the stale copyright year this repo's pre-commit workflow carried. TRI-1100
Grant issues:write to the labeling job (review feedback). TRI-1100
Greptile SummaryThis PR aligns the repository's CI and pre-commit configuration with the org-wide setup in
Confidence Score: 5/5Safe to merge — all changes are confined to CI configuration and tooling; no production code is touched. The diff is limited to pre-commit and GitHub Actions configuration. The previously flagged issues (flake8 arg quoting, xargs null-delimiter, version tag) have been addressed. The one remaining finding is a minor regex anchor in the codespell exclude pattern that does not affect hook correctness for the common case. No runtime logic or business-critical paths are affected. .pre-commit-config.yaml — minor codespell exclude regex issue; all other files are straightforward. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR opened / pushed] --> B{Same-repo or fork?}
B -->|Same-repo| C[pull_request event]
B -->|Fork| D[pull_request_target event]
C --> E[conventional-pr job]
D --> E
E --> F[Calls org reusable workflow\ntriton-inference-server/.github\n@ v1.4.3]
F --> G[Validates PR title\nConventional Commits format]
F --> H[Applies type label\nci / feat / fix / ...]
A --> I[pre-commit job\npull_request event]
I --> J[actions/checkout\nfetch-depth: 2]
J --> K[git diff HEAD^1 HEAD\n--diff-filter=d -z]
K --> L[xargs -0\npre-commit run --files]
L --> M{Hooks pass?}
M -->|Yes| N[CI green]
M -->|No| O[CI fails\nshows diff]
subgraph pre-commit hooks
P[isort + black + flake8]
Q[clang-format]
R[codespell --toml pyproject.toml]
S[conventional-pre-commit\ncommit-msg stage]
T[pre-commit-hooks\ncheck-yaml / detect-private-key / ...]
U[add-license\norg .github @ v1.4.3]
end
L --> P & Q & R & S & T & U
Reviews (2): Last reviewed commit: "ci: harden CI workflows and configs per ..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| run: echo "modified_files=$(git diff --name-only -r HEAD^1 HEAD | xargs)" >> $GITHUB_OUTPUT | ||
| - uses: actions/setup-python@v6.0.0 | ||
| - uses: pre-commit/action@v3.0.1 | ||
| with: | ||
| extra_args: --files ${{ steps.modified-files.outputs.modified_files }} |
There was a problem hiding this comment.
--files for paths containing spaces. xargs converts newlines to spaces, so --files ${{ steps.modified-files.outputs.modified_files }} is shell-word-split by the runner — any file path with a space becomes two separate (not-found) arguments. A safer approach passes the newline-separated list directly via a multi-line env variable or uses xargs -d ' ' to preserve path boundaries.
There was a problem hiding this comment.
Fixed in the v1.4.3 round: the workflow now uses a null-delimited pipeline (git diff --name-only -z --diff-filter=d | xargs -0 --no-run-if-empty pre-commit run --files ...) - paths with spaces survive, deletion-only PRs skip cleanly, deleted paths are filtered, and nothing is interpolated through YAML extra_args anymore. pre-commit env caching is preserved via actions/cache keyed on the config hash.
| rev: v1.4.2 | ||
| hooks: | ||
| - id: add-license |
There was a problem hiding this comment.
v1.4.2 in the code does not match the PR description. The description consistently states rev: v1.4.1 as the pinned tag that "already exists" and has "CI is green," while both this file and conventional-pr.yml reference v1.4.2. If v1.4.2 is intentional, the description should be updated to avoid confusion; if v1.4.1 was the intended pin, the rev here needs correcting.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
There was a problem hiding this comment.
Fixed - documentation drift: the descriptions have been refreshed to the current pinned tag v1.4.3 (they lagged behind the tag revisions; the tag exists and CI is green fleet-wide).
- conventional-pr stub: dual pull_request/pull_request_target triggers so fork PRs from external contributors get labeled too (the reusable workflow never checks out PR code); explicit contents:read; pinned v1.4.3. - pre-commit workflow: robust modified-files runner (null-delimited paths, deletion-only PRs handled, deleted paths filtered, no undocumented -r flag, cache keyed on config hash). - flake8 args quoted correctly (the flow-scalar form split at commas and silently reduced the select list). - hooks pinned to .github v1.4.3. TRI-1100
|
Closing: the team is moving away from centralized org-level configuration in favor of per-repository self-contained setups (see triton-inference-server/server#8897 for the first decentralized implementation). Branch retained for reference. TRI-1100 |
2 participants
What does the PR do?
Aligns this repository with the org-wide setup consolidated in triton-inference-server/.github:
.pre-commit-config.yaml: shared baseline hooks, conventional-commit message validation (commit-msg stage), and the centralizedadd-licensehook from the org.githubrepository (rev: v1.4.3— excludes.github/templates, never rewrites LICENSE files).conventional-prworkflow (@v1.4.3): validates the PR title against Conventional Commits (hard gate — it becomes the squash-merge commit), derives one human-readable label per distinct type found in the title and all conforming commit subjects (e.g.ci:→CI/CD,feat:→feature,fix:→fix), enforces org-wide label colors/descriptions, detects cherry-picks, and fails if no type is derivable and no type label is assigned.Repo-specific: the
tensorrt_llmsubmodule is excluded from all hooks; Python toolchain aligns from yapf/autoflake to the shared baseline (files reformat only when touched); adds pyproject.toml; the stale local bug_report.yml is removed (issues route to server); the repo's safety hooks from main (check-added-large-files, check-symlinks, detect-private-key) are preserved.Depends on triton-inference-server/.github#5 (pinned tags current:
v1.4.3— already exist, CI is green).Pros / Cons
Pros
.githubrepo) for hooks, templates, issue routing, and the PR-title workflow — one change propagates everywhere.Cons / risks
.githubrepository (tags are write-once; changes ship as a new tag + rev bump)..githubrepository to remain public.Related Issues / PRs
Related PRs:
Test plan
pre-commit validate-configpasses;pre-commit run --files <PR diff>passes locally with the centralized hooks pinned to the .github branch SHA.v1.4.3exists: the conventional-pr check validates this PR's own title and applies thecilabel.Caveats
Checklist
<commit_type>: <Title>(conventional commit)