mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 13:41:30 +00:00
shankar0123
3275f9f1e0
CI run on the ecb8896 push surfaced two real failures rooted in the
2026-05-04 docs overhaul:
1. G-3 env-docs-drift caught two phantom CERTCTL_* env vars I'd
introduced in the Phase 4 follow-on connector pages
(CERTCTL_CA_CERT_PATH_NEW in adcs.md was a placeholder I made
up; CERTCTL_EJBCA_POLL_MAX_WAIT_SECONDS in ejbca.md does not
exist in source). Both removed.
2. QA-doc Part-count drift guard tried to grep
docs/qa-test-guide.md and docs/testing-guide.md, both of which
were renamed/deleted in Phase 2/Phase 5. The Part-count drift
class died with testing-guide.md (Phase 5 prune dispersed its
content); the seed-count drift class is still live but pointed
at the wrong path.
Fixes:
- Removed the QA-doc Part-count drift guard from ci.yml (premise
dead) plus its standalone scripts/qa-doc-part-count.sh peer.
- Retargeted the QA-doc seed-count drift guard from
docs/qa-test-guide.md → docs/contributor/qa-test-suite.md (the
Phase 2 target). Updated both ci.yml inline copy and
scripts/qa-doc-seed-count.sh.
- Updated Makefile qa-stats: target to drop the testing-guide.md
Parts metric (file is gone).
- Updated Makefile verify-docs: target to drop the part-count step.
G-3 was also failing in the second direction (env vars defined in
config.go but never documented anywhere). 16 vars surfaced —
features.md (deleted Phase 6) and testing-guide.md (deleted Phase 5)
had been their canonical home. Created
docs/reference/configuration.md as the new home: a compact
operator-facing env-var reference covering scheduler intervals, job
lifecycle, rate limiting, audit, deploy verify, database,
agent-side, and SCEP profile binding. Added to docs/README.md
Reference table.
Doc-side updates to qa-test-suite.md to reframe its references to
the deleted testing-guide.md (it's now self-contained: the
Part-by-Part Coverage Map IS the canonical Part inventory).
Cosmetic comment-only updates in ci.yml + scripts/ci-guards/*.sh +
scripts/dev-setup.sh to point at the new audience-organized doc
paths (docs/operator/security.md, docs/operator/tls.md,
docs/reference/architecture.md, etc.) instead of the pre-Phase-2
flat layout.
Verified: all 24 ci-guards/*.sh pass locally; qa-doc-seed-count.sh
clean. Net diff: 178 additions / 112 deletions across 13 files.
One file deleted (qa-doc-part-count.sh) and one file added
(docs/reference/configuration.md).
39 lines
1.5 KiB
Bash
39 lines
1.5 KiB
Bash
#!/usr/bin/env bash
|
|
# scripts/ci-guards/L-001-insecure-skip-verify.sh
|
|
#
|
|
# L-001 audited every production InsecureSkipVerify=true call site
|
|
# and documented the justification per site in docs/operator/tls.md. This
|
|
# script grep-fails the build if any new `InsecureSkipVerify: true`
|
|
# lands in a non-test Go file without a `//nolint:gosec` comment
|
|
# carrying the justification. Test files (_test.go) are exempt.
|
|
# Updating the documented surface goes through the docs/operator/tls.md
|
|
# table — net-new sites must be reasoned about before merge.
|
|
|
|
set -e
|
|
# Find every "InsecureSkipVerify: true" or "InsecureSkipVerify = true"
|
|
# in a non-test .go file. Then for each, check the same line OR the
|
|
# immediately preceding line for `//nolint:gosec`.
|
|
BAD=""
|
|
while IFS= read -r match; do
|
|
file=$(echo "$match" | cut -d: -f1)
|
|
line=$(echo "$match" | cut -d: -f2)
|
|
same=$(sed -n "${line}p" "$file" 2>/dev/null)
|
|
prev=$(sed -n "$((line - 1))p" "$file" 2>/dev/null)
|
|
if echo "$same $prev" | grep -q 'nolint:gosec'; then
|
|
continue
|
|
fi
|
|
BAD="$BAD\n$match"
|
|
done < <(grep -rnE 'InsecureSkipVerify:\s*true|InsecureSkipVerify\s*=\s*true' \
|
|
--include='*.go' \
|
|
--exclude='*_test.go' \
|
|
. || true)
|
|
if [ -n "$BAD" ]; then
|
|
echo "::error::L-001 regression: new InsecureSkipVerify=true site without //nolint:gosec justification:"
|
|
echo -e "$BAD"
|
|
echo ""
|
|
echo "Add a //nolint:gosec comment with justification on the same"
|
|
echo "or preceding line, AND add a row to the docs/operator/tls.md table."
|
|
exit 1
|
|
fi
|
|
echo "L-001 insecure-skip-verify: clean."
|