mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 15:01:32 +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).
29 lines
1.4 KiB
Bash
29 lines
1.4 KiB
Bash
#!/usr/bin/env bash
|
|
# scripts/ci-guards/H-009-readme-jwt.sh
|
|
#
|
|
# H-009 closed by Bundle D as verified-already-clean: at audit time
|
|
# the README does NOT advertise JWT support (certctl does not ship
|
|
# in-process JWT middleware; JWT/OIDC integration is via an
|
|
# authenticating gateway, see docs/reference/architecture.md "Authenticating-
|
|
# gateway pattern"). This script grep-fails the build if README ever
|
|
# re-introduces a sentence advertising JWT as a supported auth mode.
|
|
# Pattern: "JWT" within ~6 words of "support|auth|enabled|mode" in
|
|
# README.md. The architecture / compliance / connector docs that
|
|
# legitimately mention JWT (Google OAuth2 service-account JWT,
|
|
# step-ca provisioner JWT, JWT-via-gateway pattern) are out of
|
|
# scope — they describe what certctl does NOT do, or external
|
|
# protocol uses.
|
|
|
|
set -e
|
|
if grep -inE 'JWT.{0,40}(support|auth|enabled|mode|provider)' README.md \
|
|
| grep -v 'gateway' | grep -v 'pre-G-1'; then
|
|
echo "::error::H-009 regression: README.md appears to advertise JWT auth support."
|
|
echo "certctl does NOT ship in-process JWT middleware. JWT/OIDC"
|
|
echo "integration is via an authenticating gateway — see"
|
|
echo "docs/reference/architecture.md::Authenticating-gateway pattern."
|
|
echo "If you added a sentence about JWT to README, either remove"
|
|
echo "it or rewrite it to point at the gateway pattern."
|
|
exit 1
|
|
fi
|
|
echo "H-009 readme-jwt: clean."
|