ci: gate the release on shell lint, from one shared script
Lint / hadolint (push) Successful in 10s
Lint / actionlint (push) Successful in 17s
Publish Docker Image / lint-gate (push) Successful in 15s
Publish Docker Image / resolve-versions (push) Successful in 9s
Publish Docker Image / base-decide (push) Successful in 16s
Publish Docker Image / build-base (push) Has been skipped
Publish Docker Image / smoke-studio (push) Successful in 5m9s
Publish Docker Image / smoke (push) Successful in 7m39s
Publish Docker Image / build-variant-studio (push) Successful in 17m15s
Publish Docker Image / build-variant (push) Successful in 17m58s
Publish Docker Image / update-description (push) Successful in 8s
Publish Docker Image / promote-base-latest (push) Successful in 12s
Lint / hadolint (push) Successful in 10s
Lint / actionlint (push) Successful in 17s
Publish Docker Image / lint-gate (push) Successful in 15s
Publish Docker Image / resolve-versions (push) Successful in 9s
Publish Docker Image / base-decide (push) Successful in 16s
Publish Docker Image / build-base (push) Has been skipped
Publish Docker Image / smoke-studio (push) Successful in 5m9s
Publish Docker Image / smoke (push) Successful in 7m39s
Publish Docker Image / build-variant-studio (push) Successful in 17m15s
Publish Docker Image / build-variant (push) Successful in 17m58s
Publish Docker Image / update-description (push) Successful in 8s
Publish Docker Image / promote-base-latest (push) Successful in 12s
v1.8.14's first attempt spent ~46 minutes building a base image for a tree whose own lint had been failing for 24 hours. shellcheck had already flagged the defect (SC2289, severity error) on the push that introduced it; the lint workflow went red at run 186 and nobody read it. lint.yml deliberately skips tag pushes and its reasoning is sound -- the tagged tree was already linted on main, and a tag-ref lint run sorts above the publish run, making a release look finished before anything ships. The missing invariant was never "lint the tag". It was "do not RELEASE a tree whose lint failed", and only a job inside the publish workflow can enforce that. So: extract the shell-lint logic from lint.yml into scripts/lint-shell.sh and call it from both places, then add a lint-gate job that resolve-versions depends on. resolve-versions is the graph root, so gating it gates everything. Cost is ~40 s at the front of a release; the alternative already cost fifty minutes. Extracted rather than copied on purpose. A second copy of a check is the drift this repo keeps paying for -- the same evening produced a skillset mirror that had sat 9579 B behind its upstream through two consecutive edits. The script adds one behaviour the inline version lacked: if shellcheck is not installed it exits 2 rather than silently finding nothing, inheriting the existing "a gate that cannot run must not pass" rule from hooks/pre-commit in the skillset repo. Without that, reordering the install step away would turn the gate into a green tick over zero checks. Verified locally with a stubbed shellcheck (the real binary is not in the devbox), five cases, each with its expectation stated first: absent shellcheck -> rc=2; stub pass -> rc=0 and a non-zero file count; stub fail -> rc=1; a deliberately unterminated `if` planted in scripts/ -> rc=1 via the bash -n half, naming the file; removal -> rc=0 again. Discovery cross-checks against CI's own number: the inline version reported 12 files, the extracted one reports 13, the difference being lint-shell.sh itself. YAML re-parsed (10 jobs, was 9) with an assertion that resolve-versions needs lint-gate, and the repo's check-workflow-shell.sh guard still passes.
This commit is contained in:
@@ -0,0 +1,91 @@
|
||||
#!/usr/bin/env bash
|
||||
# Shellcheck + syntax-check every shell script in this repo. Severity: error.
|
||||
#
|
||||
# SINGLE SOURCE OF TRUTH for two callers:
|
||||
# .gitea/workflows/lint.yml — advisory, every branch push and PR
|
||||
# .gitea/workflows/docker-publish.yml — the release GATE (lint-gate job)
|
||||
# Extracted from lint.yml on 2026-09-08 rather than copied, because a second
|
||||
# copy is exactly the drift this repo has been bitten by (see skillset's
|
||||
# pi-extensions mirror, refreshed the same evening after sitting 9579 B behind).
|
||||
#
|
||||
# WHY THIS CHECK EXISTS AT ALL
|
||||
# actionlint shellchecks workflow `run:` steps only. The repo's own scripts —
|
||||
# entrypoint.sh, scripts/*.sh, and the extensionless tools under
|
||||
# rootfs/usr/local/bin/ — were never shellchecked. A sibling repo with the same
|
||||
# gap shipped a broken `echo "$json" | python3 <<'EOF' ... json.load(sys.stdin)`
|
||||
# for two months: with no script argument python reads its SCRIPT from stdin,
|
||||
# so the heredoc IS stdin and json.load hits EOF. shellcheck flags that at
|
||||
# severity error (SC2259); nothing ever ran it.
|
||||
#
|
||||
# WHY THE RELEASE GATES ON IT (added 2026-09-08, the expensive way round)
|
||||
# v1.8.14's first attempt failed after build-base had already spent ~46 min:
|
||||
# scripts/smoke-test.sh had an apostrophe inside a single-quoted exec_test body
|
||||
# ("the fleet\'s"), which CLOSES the string, so the body truncated and its tail
|
||||
# ran on the CI runner instead of inside the image. shellcheck had already
|
||||
# caught it as SC2289 at severity error — the lint job went red on the very
|
||||
# push that introduced it and stayed red for 24 hours, unread. lint.yml
|
||||
# deliberately does not run on tag pushes (sound: the tagged tree was linted on
|
||||
# main, and a tag-ref lint run sorts above the publish run and makes a release
|
||||
# look finished early). The gap was never "lint the tag" — it was that a tree
|
||||
# whose lint FAILED could still be released. Hence a gate inside the publish
|
||||
# workflow, ~40 s, ahead of everything expensive.
|
||||
#
|
||||
# SEVERITY CHOICE
|
||||
# -S error is 0 findings across this repo when clean, so it is free to add.
|
||||
# -S warning is NOT free here (19x SC2088 tilde-in-quotes in
|
||||
# recreate-sanity-check.sh, plus assorted SC2016 — both intentional), and a
|
||||
# noisy gate trains people to ignore it. Error-only, matching the
|
||||
# SHELLCHECK_OPTS philosophy in lint.yml.
|
||||
#
|
||||
# Usage: bash scripts/lint-shell.sh [root] (default root: repo top level)
|
||||
set -uo pipefail
|
||||
|
||||
root="${1:-}"
|
||||
if [ -z "$root" ]; then
|
||||
root="$(git rev-parse --show-toplevel 2>/dev/null || pwd)"
|
||||
fi
|
||||
cd "$root" || { echo "::error::cannot cd to $root"; exit 2; }
|
||||
|
||||
# A gate that cannot run must not pass. Without this, a machine (or a CI job
|
||||
# whose install step was reordered away) without shellcheck would sail through
|
||||
# printing nothing, which is the failure mode this whole file exists to prevent.
|
||||
if ! command -v shellcheck >/dev/null 2>&1; then
|
||||
echo "::error::shellcheck not found — the gate cannot run, so it must not pass" >&2
|
||||
echo " install it (apt-get install -y shellcheck) or run this in CI" >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Union of two signals, because either alone misses a real case: a shebang scan
|
||||
# misses a sourced fragment with no shebang, and a *.sh glob misses the
|
||||
# extensionless tools in rootfs/usr/local/bin/. Silent skipping is precisely the
|
||||
# failure mode this gate exists to prevent, so err toward over-collecting.
|
||||
# -print0/mapfile -d '' so a path containing a space cannot silently split.
|
||||
mapfile -d '' -t all_files < <(find . -not -path './.git/*' -type f -print0)
|
||||
sh_files=()
|
||||
for f in "${all_files[@]}"; do
|
||||
case "$f" in *.sh) sh_files+=("$f"); continue;; esac
|
||||
if head -n1 "$f" 2>/dev/null | grep -qE '^#!.*\b(bash|sh)\b'; then
|
||||
sh_files+=("$f")
|
||||
fi
|
||||
done
|
||||
|
||||
echo "Checking ${#sh_files[@]} shell file(s) with $(shellcheck --version | awk '/version:/{print $2}')"
|
||||
# A green tick over an empty file set is not a check.
|
||||
if [ "${#sh_files[@]}" -eq 0 ]; then
|
||||
echo "::error::no shell files found — the shebang scan or the checkout is wrong"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
rc=0
|
||||
shellcheck -S error -f gcc "${sh_files[@]}" || rc=1
|
||||
|
||||
# bash -n catches a different class than shellcheck (unbalanced constructs it
|
||||
# declines to parse), so both run and both count.
|
||||
for f in "${sh_files[@]}"; do
|
||||
bash -n "$f" || { echo "::error file=$f::bash -n failed"; rc=1; }
|
||||
done
|
||||
|
||||
if [ "$rc" -eq 0 ]; then
|
||||
echo "OK: ${#sh_files[@]} shell file(s) clean at severity error"
|
||||
fi
|
||||
exit "$rc"
|
||||
Reference in New Issue
Block a user