feat(docs): add a user-facing security posture page - #243
Merged
Conversation
Add docs/pages/explanation/security.md, an explanation-quadrant page that reassures package users by naming every security measure the project runs and what it means for their trust. Gated on repo_visibility so it never claims a control a private repo does not run (no CodeQL/Scorecard section there). Ships to generated projects and the template repo. Bundles two fixes surfaced by the v0.33.0 fan-out canary: - add S301/S110/S311 to the generated tests/** ruff ignore (test code legitimately uses pickle, try/except/pass, and non-crypto random), so repos need no per-repo triage for them - add a code_owner answer (default @gtauzin) for CODEOWNERS, replacing the bare @{github_username} org name that GitHub rejects as an invalid code owner
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a user-facing security posture explanation page (
docs/pages/explanation/security.md) to generated projects and to the template repo's own docs. It reassures prospective package users by naming every measure the project runs (trusted publishing, attestations, SBOM, SAST, secret scanning, least-privilege CI, scoped automation) and what each means for their trust.repo_visibility, so a private project's page does not claim CodeQL or the OpenSSF Scorecard (which it does not run); it presents the free equivalents and explains the difference. Fail-loud applies to reassurance too.Explanation → Security; the index auto-lists it via<!-- SUBPAGES -->.Bundled fixes (surfaced by the v0.33.0 fan-out canary on yohou)
tests/**ruff ignore gainsS301/S110/S311(test code legitimately uses pickle, try/except/pass, non-crypto random) so no repo needs per-repo triage for them.code_owneranswer (default@gtauzin) drivesCODEOWNERS, replacing the bare@{{ github_username }}org name that GitHub rejects as an invalid code owner.Release plan
This bundles with the harden-fleet-security controls as v0.34.0, then fans out to all 7 repos in one pass. Note: this touches
mkdocs.ymlnav, so that fan-out reintroduces the nav-clobber discipline (per-section nav counts before eachcopier update).