mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
build(Makefile): capture pre-commit output to log files (#22978)
pre-commit was noisy: every sub-target dumped full stdout/stderr to the terminal, burying failures in pages of compiler output and lint details. Teach timed-shell.sh a quiet mode via MAKE_LOGDIR: when set, recipe output is redirected to per-target log files and a one-line status is printed instead. When unset, behavior is unchanged (with a refreshed output format). Makefile changes: - pre-commit creates a tmpdir, passes MAKE_LOGDIR to sub-makes - Drop --output-sync=target (log files eliminate interleaving) - Add --no-print-directory to suppress Entering/Leaving noise - Split check-unstaged and check-untracked into separate defines - Restyle both with colored indicators and clearer instructions - Clean up tmpdir on success, preserve on failure for debugging
This commit is contained in:
@@ -27,6 +27,7 @@ ifdef MAKE_TIMED
|
||||
SHELL := $(CURDIR)/scripts/lib/timed-shell.sh
|
||||
.SHELLFLAGS = $@ -ceu
|
||||
export MAKE_TIMED
|
||||
export MAKE_LOGDIR
|
||||
endif
|
||||
|
||||
# This doesn't work on directories.
|
||||
@@ -515,6 +516,9 @@ install: build/coder_$(VERSION)_$(GOOS)_$(GOARCH)$(GOOS_BIN_EXT)
|
||||
|
||||
BOLD := $(shell tput bold 2>/dev/null)
|
||||
GREEN := $(shell tput setaf 2 2>/dev/null)
|
||||
RED := $(shell tput setaf 1 2>/dev/null)
|
||||
YELLOW := $(shell tput setaf 3 2>/dev/null)
|
||||
DIM := $(shell tput dim 2>/dev/null || tput setaf 8 2>/dev/null)
|
||||
RESET := $(shell tput sgr0 2>/dev/null)
|
||||
|
||||
fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/biome fmt/markdown
|
||||
@@ -729,33 +733,41 @@ lint/typos: build/typos-$(TYPOS_VERSION)
|
||||
define check-unstaged
|
||||
unstaged="$$(git diff --name-only)"
|
||||
if [[ -n $$unstaged ]]; then
|
||||
echo "ERROR: unstaged changes in tracked files:"
|
||||
echo "$$unstaged"
|
||||
echo
|
||||
echo "Review each change (git diff), verify correctness, then stage:"
|
||||
echo " git add -u && git commit"
|
||||
echo "$(RED)✗ check unstaged changes$(RESET)"
|
||||
echo "$$unstaged" | sed 's/^/ - /'
|
||||
echo ""
|
||||
echo "$(DIM) Verify generated changes are correct before staging:$(RESET)"
|
||||
echo "$(DIM) git diff$(RESET)"
|
||||
echo "$(DIM) git add -u && git commit$(RESET)"
|
||||
exit 1
|
||||
fi
|
||||
endef
|
||||
define check-untracked
|
||||
untracked=$$(git ls-files --other --exclude-standard)
|
||||
if [[ -n $$untracked ]]; then
|
||||
echo "WARNING: untracked files (not in this commit, won't be in CI):"
|
||||
echo "$$untracked"
|
||||
echo
|
||||
echo "$(YELLOW)? check untracked files$(RESET)"
|
||||
echo "$$untracked" | sed 's/^/ - /'
|
||||
echo ""
|
||||
echo "$(DIM) Review if these should be committed or added to .gitignore.$(RESET)"
|
||||
fi
|
||||
endef
|
||||
|
||||
pre-commit:
|
||||
start=$$(date +%s)
|
||||
echo "=== Phase 1/2: gen + fmt ==="
|
||||
$(MAKE) -j$(PARALLEL_JOBS) --output-sync=target MAKE_TIMED=1 gen fmt
|
||||
logdir=$$(mktemp -d "$${TMPDIR:-/tmp}/coder-pre-commit.XXXXXX")
|
||||
echo "$(BOLD)pre-commit$(RESET) ($$logdir)"
|
||||
echo "gen + fmt:"
|
||||
$(MAKE) --no-print-directory -j$(PARALLEL_JOBS) MAKE_TIMED=1 MAKE_LOGDIR=$$logdir gen fmt
|
||||
$(check-unstaged)
|
||||
echo "=== Phase 2/2: lint + build ==="
|
||||
$(MAKE) -j$(PARALLEL_JOBS) --output-sync=target MAKE_TIMED=1 \
|
||||
echo "lint + build:"
|
||||
$(MAKE) --no-print-directory -j$(PARALLEL_JOBS) MAKE_TIMED=1 MAKE_LOGDIR=$$logdir \
|
||||
lint \
|
||||
lint/typos \
|
||||
build/coder-slim_$(GOOS)_$(GOARCH)$(GOOS_BIN_EXT)
|
||||
$(check-unstaged)
|
||||
echo "$(BOLD)$(GREEN)=== pre-commit passed in $$(( $$(date +%s) - $$start ))s ===$(RESET)"
|
||||
$(check-untracked)
|
||||
rm -rf $$logdir
|
||||
echo "$(GREEN)✓ pre-commit passed$(RESET) ($$(( $$(date +%s) - $$start ))s)"
|
||||
.PHONY: pre-commit
|
||||
|
||||
offlinedocs/check: offlinedocs/node_modules/.installed
|
||||
|
||||
@@ -8,6 +8,9 @@
|
||||
# SHELL := $(CURDIR)/scripts/lib/timed-shell.sh
|
||||
# .SHELLFLAGS = $@ -ceu
|
||||
#
|
||||
# When MAKE_LOGDIR is set, recipe output is captured to a log file.
|
||||
# Otherwise output goes to stdout/stderr as normal.
|
||||
#
|
||||
# $(shell ...) uses SHELL but passes -c directly, not .SHELLFLAGS.
|
||||
# Detect this and delegate to bash without timing output.
|
||||
if [[ $1 == -* ]]; then
|
||||
@@ -19,23 +22,32 @@ set -eu
|
||||
target=$1
|
||||
shift
|
||||
|
||||
bold=$(tput bold 2>/dev/null) || true
|
||||
dim=$(tput dim 2>/dev/null) || dim=$(tput setaf 8 2>/dev/null) || true
|
||||
green=$(tput setaf 2 2>/dev/null) || true
|
||||
red=$(tput setaf 1 2>/dev/null) || true
|
||||
reset=$(tput sgr0 2>/dev/null) || true
|
||||
|
||||
start=$(date +%s)
|
||||
echo "${bold}==> ${target}${reset}"
|
||||
|
||||
set +e
|
||||
bash "$@"
|
||||
if [[ -n ${MAKE_LOGDIR:-} ]]; then
|
||||
logfile="${MAKE_LOGDIR}/${target//\//-}.log"
|
||||
bash "$@" >"$logfile" 2>&1
|
||||
else
|
||||
printf '%s○%s %s\n' "$dim" "$reset" "$target"
|
||||
bash "$@"
|
||||
fi
|
||||
rc=$?
|
||||
set -e
|
||||
|
||||
elapsed=$(($(date +%s) - start))
|
||||
if ((rc == 0)); then
|
||||
echo "${bold}${green}==> ${target} completed in ${elapsed}s${reset}"
|
||||
printf '%s✓%s %s (%ds)\n' "$green" "$reset" "$target" "$elapsed"
|
||||
else
|
||||
echo "${bold}${red}==> ${target} FAILED after ${elapsed}s${reset}" >&2
|
||||
exit $rc
|
||||
if [[ -n ${MAKE_LOGDIR:-} ]]; then
|
||||
printf '%s✗%s %s (%ds) → %s\n' "$red" "$reset" "$target" "$elapsed" "$logfile"
|
||||
else
|
||||
printf '%s✗%s %s (%ds)\n' "$red" "$reset" "$target" "$elapsed"
|
||||
fi
|
||||
exit "$rc"
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user