mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 13:31:36 +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).
42 lines
2.2 KiB
Bash
42 lines
2.2 KiB
Bash
#!/usr/bin/env bash
|
|
# scripts/qa-doc-seed-count.sh
|
|
#
|
|
# Bundle P / Strengthening #6 — QA-doc seed-count drift guard.
|
|
# Forces every PR that adds a seed row to migrations/seed_demo.sql
|
|
# to keep docs/contributor/qa-test-suite.md::Seed Data Reference in sync.
|
|
#
|
|
# Per ci-pipeline-cleanup bundle Phase 11 / frozen decision 0.13:
|
|
# moved out of CI (was in ci.yml) — operator runs via 'make verify-docs'
|
|
# pre-tag.
|
|
|
|
set -e
|
|
# Seed-cert count: agnostic to documented header format. The current
|
|
# documented count lives in `### Certificates (32 total in ...` —
|
|
# extract the first integer in that header.
|
|
DOC_CERTS=$(grep -oE '### Certificates \([0-9]+' docs/contributor/qa-test-suite.md | grep -oE '[0-9]+' | head -1)
|
|
# Authoritative count: unique mc-* IDs in seed_demo.sql.
|
|
SEED_CERTS=$(grep -oE 'mc-[a-z0-9_-]+' migrations/seed_demo.sql | sort -u | wc -l | tr -d ' ')
|
|
if [ -z "$DOC_CERTS" ]; then
|
|
echo "::warning::Could not extract documented cert count from docs/contributor/qa-test-suite.md."
|
|
echo " Skipping cert-count drift check (header format may have changed)."
|
|
elif [ "$DOC_CERTS" != "$SEED_CERTS" ]; then
|
|
echo "::error::DRIFT — qa-test-suite.md says $DOC_CERTS certs; seed_demo.sql has $SEED_CERTS unique mc-* IDs."
|
|
echo " Update docs/contributor/qa-test-suite.md::Seed Data Reference to match."
|
|
exit 1
|
|
fi
|
|
# Issuers: seed-table count vs doc claim.
|
|
DOC_ISS=$(grep -oE '### Issuers \([0-9]+' docs/contributor/qa-test-suite.md | grep -oE '[0-9]+' | head -1)
|
|
# Authoritative: unique iss-* IDs (close enough proxy; the issuers
|
|
# table count IS the unique-ID count for this prefix).
|
|
SEED_ISS=$(grep -oE 'iss-[a-z0-9_-]+' migrations/seed_demo.sql | sort -u | wc -l | tr -d ' ')
|
|
if [ -z "$DOC_ISS" ]; then
|
|
echo "::warning::Could not extract documented issuer count."
|
|
elif [ "$DOC_ISS" != "$SEED_ISS" ] && [ "$((SEED_ISS - DOC_ISS))" -gt 5 ]; then
|
|
# Allow up to 5pp slack — iss-* IDs appear in audit_events and
|
|
# other reference tables that aren't issuer-table rows. Drift
|
|
# only flags when the spread grows large.
|
|
echo "::error::DRIFT — qa-test-suite.md says $DOC_ISS issuers; seed_demo.sql has $SEED_ISS unique iss-* IDs (spread > 5)."
|
|
exit 1
|
|
fi
|
|
echo "qa-doc-seed-count: clean."
|