Add CI custom linter framework conventions and check-custom meta target - #1198
Open
ptone wants to merge 3 commits into
Open
Add CI custom linter framework conventions and check-custom meta target#1198ptone wants to merge 3 commits into
ptone wants to merge 3 commits into
Conversation
added 3 commits
August 22, 2026 12:30
Introduce hack/LINT-CONVENTIONS.md documenting shared conventions for custom lint check scripts (exit codes, severity levels, allowlist format, self-test expectations, provenance reporting, script structure, CI integration notes). Add a `make check-custom` meta target that runs all custom lint checks (currently compat-literals and check-authz-guards). Update ci and ci-full targets to depend on check-custom instead of listing individual checks. Refs #1193
- R1: Provenance section now says 'commit SHA' and shows dirty-tracking matching the provenance() function in check-authz-guards.sh - R2: Self-test fixtures can be inline heredocs (current approach) or standalone files in hack/testdata/ - N1: Exit code 3/4 guidance now qualifies that formatting-grade checks exit 0 on missing tools, with cross-reference to Severity Levels - N2: Allowlist references check-project-compat-literals.sh for a populated example and check-authz-guards.sh for anchoring guidance Refs #1193
- O-1: CI Integration now notes direct invocation is for exit-code-sensitive (security-grade) checks; formatting-grade checks may use make - O-2: Script Structure template adds cd-to-repo-root as step 3, matching both reference implementations - N-1: Exit code section now notes formatting-grade checks may exit 0 for both code 3 (missing tool) and code 4 (no candidates) Refs #1193
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
1 participant
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
hack/LINT-CONVENTIONS.mddocumenting shared conventions for custom CI lint check scripts: exit codes (0-4), severity levels (security vs formatting), allowlist format, self-test expectations, provenance reporting, script structure template, and CI integration notes.make check-custommeta target that runs all custom lint checks (compat-literals,check-authz-guards) as a single convenience target.ciandci-fulltargets to depend oncheck-custominstead of listing individual check targets. Individual targets remain independently runnable.Refs #1193
Test plan
make check-custompasses (runs both existing checks)make cipassesmake helpshowscheck-customwith description