ci: align pre-commit hooks and GitHub templates - #80
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
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
Review feedback on #80: main excluded "\.patch$" per hook; the baseline alignment dropped it. Vendored patches are byte- and whitespace-exact - trailing-whitespace, end-of-file-fixer, or the formatters would corrupt any touched patch. Restore it as a single top-level exclude covering every hook, including the centralized add-license. TRI-1100
Grant issues:write to the labeling job (review feedback). TRI-1100
Greptile SummaryThis PR aligns the
Confidence Score: 5/5Safe to merge — all changes are CI/configuration only, no application code is affected, and the fork-safe routing pattern for pull_request_target is correctly implemented with job-scoped minimal permissions. The PR introduces only workflow stubs, a pre-commit config overhaul, and a new pyproject.toml. The pull_request_target routing logic is correct and well-commented, hook exclusions are properly centralized, and the reusable workflow is pinned by tag with write-once semantics documented. No application logic is touched. No files require special attention, though conventional-pr.yml and pre-commit.yml carry minor hardening opportunities noted in the review comments. Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant GH as GitHub Events
participant CPR as conventional-pr.yml
participant RW as Reusable Workflow<br/>(org .github@v1.4.3)
participant PC as pre-commit.yml
participant Cache as actions/cache
participant Hooks as Pre-commit Hooks<br/>(.pre-commit-config.yaml)
Dev->>GH: Push commit (commit-msg hook runs locally)
Note over Dev: conventional-pre-commit<br/>validates commit message
Dev->>GH: Open / update PR
GH->>CPR: pull_request (same-repo) OR pull_request_target (fork)
CPR->>CPR: Route by event + head.repo check
CPR->>RW: "uses conventional-pr.yml@v1.4.3"
RW->>GH: Validate PR title (Conventional Commits)
RW->>GH: Derive and apply type label
RW->>GH: Detect cherry-picks
GH->>PC: pull_request event
PC->>Cache: Restore ~/.cache/pre-commit
PC->>PC: "git diff --name-only -z --diff-filter=d HEAD^1 HEAD"
PC->>Hooks: pre-commit run --files modified-files
Hooks->>Hooks: isort, black, flake8, clang-format, codespell, add-license
Reviews (2): Last reviewed commit: "ci: harden CI workflows and configs per ..." | Re-trigger Greptile |
| rev: v1.4.2 | ||
| hooks: |
There was a problem hiding this comment.
Version tag mismatch with PR description
The PR description explicitly states v1.4.1 at least three times ("pinned tags current: v1.4.1 — already exist, CI is green", "caller stub...@v1.4.1", "centralized add-license hook...rev: v1.4.1"), but both this file and conventional-pr.yml pin to v1.4.2. If v1.4.2 is not yet published in the org .github repository, pre-commit install will fail to resolve the hook and the add-license step will error at runtime for every contributor.
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 |
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: adds pyproject.toml with the shared codespell/isort settings.
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)