Repository navigation
feat(ci): block git push on failing affected lint checks #7185
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
81dfcc2
feat(ci): block git push on failing affected lint checks
kyle-sexton 724bdbb
Merge branch 'main' into feat/check-affected-push-hook
kyle-sexton 65750b0
fix(ci): pin the pre-push hook to this project and skip linting dirty…
kyle-sexton 2785adb
fix(ci): skip every check on dirty changed files and keep deletions i…
kyle-sexton a789f92
fix(ci): skip the pre-push run when the branch changes check tooling
kyle-sexton 718231f
test(ci): cover the settings.json gate that refuses a changed push hook
kyle-sexton File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
.changes/source-control/feat-check-affected-push-hook-60899ed0.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| bump: patch | ||
| --- | ||
|
|
||
| ### Changed | ||
|
|
||
| - The `ready` step runs `scripts/check-affected.sh --tests` on the merged head as its deterministic gate when the repository ships that script. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,260 @@ | ||
| #!/usr/bin/env bash | ||
| # PreToolUse(Bash) hook: before a `git push` from a session in this repository, | ||
| # run scripts/check-affected.sh and block the push (exit 2, summary on stderr) | ||
| # when a check fails, so a lint finding costs a local run instead of a CI round. | ||
| # | ||
| # Wired in .claude/settings.json with `if: "Bash(git push *)"`, which also | ||
| # matches a bare `git push`: a trailing ` *` that is the rule's only wildcard | ||
| # matches the bare command | ||
| # (https://code.claude.com/docs/en/permissions#wildcard-patterns). That filter is | ||
| # best-effort and also fires on any command holding $(), backticks or $VAR | ||
| # (https://code.claude.com/docs/en/hooks#bash-if-matching), so this script | ||
| # re-checks that a subcommand really is `git push` before it spends a run | ||
| # (docs/conventions/hook-precision/README.md, rule 2). A quoted or heredoc | ||
| # mention of "git push" is data, not a push. | ||
| # | ||
| # Stays quiet (exit 0) on: no real push; a push that only deletes remote refs, | ||
| # only pushes tags, or is a dry run; a push after a `cd`/`pushd` in the same | ||
| # command, whose directory this parser does not track; a push from any working | ||
| # tree other than the session's project directory, including another worktree | ||
| # of the same clone; a branch that changes check tooling (trust model below), | ||
| # with a notice; a tree with no scripts/check-affected.sh; a payload it | ||
| # cannot read; and a check-affected run that could not start (exit 2), since an | ||
| # unreadable state is not a finding. | ||
| # | ||
| # Trust model: it runs scripts/check-affected.sh only from the working tree that | ||
| # holds the .claude/settings.json registering this hook, and only when the code | ||
| # the checks run there matches origin/main. Claude Code reads that settings file | ||
| # once the folder is trusted | ||
| # (https://code.claude.com/docs/en/hooks#workspace-trust), but the scripts run | ||
| # at push time from whatever branch is checked out then, so a contributor | ||
| # branch checked out later in the same tree (to review or fix it) would run its | ||
| # own check code. So before running anything this script diffs the working tree | ||
| # and untracked files against the merge-base with origin/main; a change to any | ||
| # TOOLING path skips the run with one notice, and CI checks that branch. No | ||
| # origin/main to compare against skips it too. This script and lib/hook-utils.sh | ||
| # run before that diff, so the settings command first requires both to match | ||
| # the merge-base. | ||
| # | ||
| # It checks the checked-out HEAD, not a ref the push names: `git push origin | ||
| # other-branch` from another branch, or a tag pushed by bare name, is judged by | ||
| # HEAD's checks. CI still runs on whatever is pushed. | ||
| set -uo pipefail | ||
|
|
||
| HOOK_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" || exit 0 | ||
| # shellcheck source=../../lib/hook-utils.sh | ||
| source "$HOOK_DIR/../../lib/hook-utils.sh" || exit 0 | ||
|
|
||
| # push_dir_to <out-var> <command>: assigns the -C directory of the first `git | ||
| # push` subcommand that sends a branch ("." when it names none) and returns 0; | ||
| # returns 1 when no subcommand is such a push. | ||
| push_dir_to() { | ||
| local -n __pd_out="$1" | ||
| local cmd="$2" len=${#2} i=0 c q="" word="" in_word=0 heredoc="" line | ||
| local -a words=() | ||
| # Each unquoted separator ends a segment; quoted text stays inside one word, | ||
| # so `echo "git push"` is the command `echo` with one argument. | ||
| flush_word() { | ||
| ((in_word)) && words+=("$word") | ||
| word="" | ||
| in_word=0 | ||
| } | ||
| local moved=0 | ||
| end_segment() { | ||
| flush_word | ||
| [[ "${words[0]-}" == @(cd|pushd|popd) ]] && moved=1 | ||
| if ((!moved && ${#words[@]})) && segment_push_dir __pd_out "${words[@]}"; then | ||
| return 0 | ||
| fi | ||
| words=() | ||
| return 1 | ||
| } | ||
| while ((i < len)); do | ||
| c="${cmd:i:1}" | ||
| if [[ -n "$q" ]]; then | ||
| if [[ "$c" == "$q" ]]; then | ||
| q="" | ||
| elif [[ "$q" == '"' && "$c" == "\\" ]]; then | ||
| ((i++)) | ||
| word+="${cmd:i:1}" | ||
| else | ||
| word+="$c" | ||
| fi | ||
| ((i++)) | ||
| continue | ||
| fi | ||
| case "$c" in | ||
| "'" | '"') | ||
| q="$c" | ||
| in_word=1 | ||
| ;; | ||
| "\\") | ||
| ((i++)) | ||
| word+="${cmd:i:1}" | ||
| in_word=1 | ||
| ;; | ||
| ' ' | $'\t') flush_word ;; | ||
| '<') | ||
| if [[ "${cmd:i:2}" == '<<' && "${cmd:i:3}" != '<<<' ]]; then | ||
| # Heredoc: note the delimiter; its body is skipped at the next newline. | ||
| flush_word | ||
| i=$((i + 2)) | ||
| [[ "${cmd:i:1}" == '-' ]] && ((i++)) | ||
| while [[ "${cmd:i:1}" == ' ' ]]; do ((i++)); done | ||
| heredoc="" | ||
| while ((i < len)) && [[ "${cmd:i:1}" != [[:space:]\;\&\|\)] ]]; do | ||
| [[ "${cmd:i:1}" == [\'\"\\] ]] || heredoc+="${cmd:i:1}" | ||
| ((i++)) | ||
| done | ||
| continue | ||
| fi | ||
| flush_word | ||
| ;; | ||
| $'\n' | ';' | '&' | '|' | '(' | ')' | '`') | ||
| end_segment && return 0 | ||
| if [[ "$c" == $'\n' && -n "$heredoc" ]]; then | ||
| while ((i < len)); do | ||
| line="${cmd:i+1}" | ||
| line="${line%%$'\n'*}" | ||
| i=$((i + 1 + ${#line})) | ||
| [[ "${line#"${line%%[!$'\t']*}"}" == "$heredoc" ]] && break | ||
| done | ||
| heredoc="" | ||
| fi | ||
| ;; | ||
| *) | ||
| word+="$c" | ||
| in_word=1 | ||
| ;; | ||
| esac | ||
| ((i++)) | ||
| done | ||
| end_segment | ||
| } | ||
|
|
||
| # segment_push_dir <out-var> <word>...: 0 and the -C directory when the words | ||
| # are a `git push` that sends a branch. | ||
| segment_push_dir() { | ||
| local -n __sp_out="$1" | ||
| shift | ||
| local dir="." w | ||
| # Leading assignments and the shell words that precede a command. | ||
| while (($#)); do | ||
| case "$1" in | ||
| [A-Za-z_]*=*) shift ;; | ||
| '{' | '!' | then | do | else | if | while | until | time | command | env) shift ;; | ||
| *) break ;; | ||
| esac | ||
| done | ||
| [[ "${1-}" == git || "${1-}" == */git ]] || return 1 | ||
| shift | ||
| while (($#)); do | ||
| case "$1" in | ||
| -C) | ||
| dir="${2-.}" | ||
| shift 2 || return 1 | ||
| ;; | ||
| -c | --git-dir | --work-tree | --namespace) shift 2 || return 1 ;; | ||
| -*) shift ;; | ||
| *) break ;; | ||
| esac | ||
| done | ||
| [[ "${1-}" == push ]] || return 1 | ||
| shift | ||
| local tags=0 remote="" refspecs=0 sends=0 pending_tag=0 | ||
| while (($#)); do | ||
| w="$1" | ||
| shift | ||
| case "$w" in | ||
| --delete | --dry-run | -[nd]* | -[!-]*[nd]*) return 1 ;; | ||
| --tags) tags=1 ;; | ||
| -o | --push-option | --repo | --receive-pack | --exec) shift ;; | ||
| -*) ;; | ||
| *) | ||
| if [[ -z "$remote" ]]; then | ||
| remote="$w" | ||
| continue | ||
| fi | ||
| refspecs=1 | ||
| if ((pending_tag)); then | ||
| pending_tag=0 | ||
| elif [[ "$w" == tag ]]; then | ||
| pending_tag=1 | ||
| elif [[ "$w" != :* && "$w" != refs/tags/* && "$w" != +refs/tags/* ]]; then | ||
| sends=1 | ||
| fi | ||
| ;; | ||
| esac | ||
| done | ||
| # Refspecs that only delete or push tags send no branch; with none at all the | ||
| # push sends the configured branch, unless --tags narrowed it to tags. | ||
| if ((sends)) || ((!refspecs && !tags)); then | ||
| __sp_out="$dir" | ||
| return 0 | ||
| fi | ||
| return 1 | ||
| } | ||
|
|
||
| # Paths the checks execute or load code from, per what scripts/check-affected.sh | ||
| # runs without --tests: its scripts and their shell, Node and Python libraries, | ||
| # the plugin scripts and mods scripts/validate-plugins.sh runs, and the configs a | ||
| # linter loads code from or installs from. | ||
| TOOLING=( | ||
| 'scripts/*' 'lib/*' '.claude/*' 'package.json' 'package-lock.json' | ||
| '.markdownlint*' 'ruff.toml' 'pyproject.toml' '.github/requirements-ci.txt' | ||
| 'plugins/*/hooks/*' 'plugins/autonomy/skills/setup/scripts/*' | ||
| 'plugins/harness-ops/skills/audit-native-overlap/scripts/*' | ||
| ) | ||
|
|
||
| # tooling_change_to <out-var> <top>: assigns why the run must skip and returns 0 | ||
| # when the tree changes a TOOLING path against its merge-base with origin/main, | ||
| # or no merge-base can be read; returns 1 when the tooling is unchanged. | ||
| tooling_change_to() { | ||
| local -n __tc_out="$1" | ||
| local top="$2" mb changed f p | ||
| if ! mb="$(git -C "$top" merge-base HEAD refs/remotes/origin/main 2>/dev/null)" || | ||
| ! changed="$(git -C "$top" diff --no-renames --name-only "$mb" -- && | ||
| git -C "$top" ls-files --others --exclude-standard)"; then | ||
| __tc_out="no origin/main merge-base to compare check tooling against" | ||
| return 0 | ||
| fi | ||
| while IFS= read -r f; do | ||
| for p in "${TOOLING[@]}"; do | ||
| # shellcheck disable=SC2053 # $p is a glob on purpose. | ||
| if [[ "$f" == $p ]]; then | ||
| __tc_out="branch changes check tooling ($f)" | ||
| return 0 | ||
| fi | ||
| done | ||
| done <<<"$changed" | ||
| return 1 | ||
| } | ||
|
|
||
| main() { | ||
| local input cmd cwd dir top out rc why | ||
| hook::buffer_stdin_to input '.tool_input.command' '.cwd' || exit 0 | ||
| cmd="${HOOK_JQ_FIELDS[0]-}" | ||
| cwd="${HOOK_JQ_FIELDS[1]-}" | ||
| [[ -n "$cmd" ]] || exit 0 | ||
| push_dir_to dir "$cmd" || exit 0 | ||
| [[ "$dir" == /* ]] || dir="${cwd:-.}/$dir" | ||
| top="$(git -C "$dir" rev-parse --show-toplevel 2>/dev/null)" || exit 0 | ||
| # Run only the project directory's own script (the trust model above), never | ||
| # one from another worktree or repository the command points at. | ||
| [[ -n "${CLAUDE_PROJECT_DIR-}" ]] || exit 0 | ||
| [[ "$top" == "$(git -C "$CLAUDE_PROJECT_DIR" rev-parse --show-toplevel 2>/dev/null)" ]] || exit 0 | ||
| [[ -x "$top/scripts/check-affected.sh" ]] || exit 0 | ||
| if tooling_change_to why "$top"; then | ||
| printf 'check-affected pre-push: skipped, %s; CI checks it.\n' "$why" >&2 | ||
| exit 0 | ||
| fi | ||
| rc=0 | ||
| out="$(cd "$top" && bash scripts/check-affected.sh 2>&1)" || rc=$? | ||
|
kyle-sexton marked this conversation as resolved.
Resolved
|
||
| ((rc == 1)) || exit 0 | ||
| printf 'Push blocked: scripts/check-affected.sh found failing checks on this branch. Fix them, commit, and push again.\n%s\n' "$out" >&2 | ||
| exit 2 | ||
| } | ||
|
|
||
| if [[ "${BASH_SOURCE[0]}" == "$0" ]]; then | ||
| main | ||
| fi | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.