docs: add OpenSSF Security Baseline compliance assessment - #2109
Open
HayimShaul wants to merge 1 commit into
Open
docs: add OpenSSF Security Baseline compliance assessment#2109HayimShaul wants to merge 1 commit into
HayimShaul wants to merge 1 commit into
Conversation
📊 Token Validation BenchmarkComparison of this PR against the base branch. 🟢 improvement · 🔴 regression · ➖ within ±1.0% noise.
|
AkramBitar
marked this pull request as ready for review
August 6, 2026 07:34
Document where Panurus stands against the OpenSSF Open Source Project Security Baseline (OSPS Baseline) v2026.02.19, so contributors and consumers can see which security practices are in place and which are still missing. Add docs/openssf/ with an index page and one page per Baseline level: - README.md distinguishes the OSPS Baseline from the separately tracked OpenSSF Best Practices Badge, records that the project targets Level 2 in full, summarises the per-level tallies, groups the findings into six gap themes, and gives a procedure for re-running the assessment. - baseline_level_1.md, baseline_level_2.md and baseline_level_3.md cover all 64 controls with a status and per-row evidence. Every "Met" row cites a file, a release artifact or a publicly readable GitHub setting; controls that depend on organization settings or on channels outside the repository are marked "Unverified" rather than assumed. The assessment surfaces a few concrete gaps, notably that the only required status check on main is DCO while the ruleset requiring CodeQL is disabled, that release tags are lightweight and releases carry no checksum manifest, and that tests.yml interpolates a workflow_dispatch input directly into a shell step. Register the new pages in mkdocs.yml under a new Security section, which also de-orphans the existing security/selector_resource_limits.md page, and link them from docs/README.md, SECURITY.md and CONTRIBUTING.md. Signed-off-by: Hayim.Shaul@ibm.com <hayimsha@fhe03.vpc.cloud9.ibm.com>
HayimShaul
force-pushed
the
1626_document_openssf_security_baseline_compliance_status
branch
from
August 6, 2026 11:17
ab31433 to
79dc877
Compare
Contributor
Author
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
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.
Documents where Panurus stands against the OpenSSF Open Source Project Security Baseline (OSPS Baseline) v2026.02.19, so contributors and consumers can see which security practices are in place and which are still missing.
Adds
docs/openssf/with an index page and one page per Baseline level:README.md— separates the OSPS Baseline from the separately tracked OpenSSF Best Practices Badge (the two are frequently conflated), records that the project targets Level 2 in full, summarises the per-level tallies, groups the findings into six gap themes, and gives a procedure for re-running the assessment.baseline_level_1.md/baseline_level_2.md/baseline_level_3.md— all 64 controls with a status and per-row evidence.Every Met row cites a file, a release artifact, or a publicly readable GitHub setting. Controls that depend on organization settings or on channels outside the repository are marked Unverified rather than assumed, so the tables can be trusted as evidence.
Current state: Level 1 20/24 met, Level 2 11/19 met, Level 3 3/21 met.
Concrete gaps the assessment surfaced:
mainisDCO; the ruleset that additionally required CodeQL hasenforcement: disabled, andrequired_approving_review_countis0despite the documented One Approve Policy.tests.ymlinterpolates theworkflow_dispatchinputfsc-versiondirectly into arun:step instead of passing it throughenv:.tests.yml,md_links.ymlandprotect-integration-test-types.ymldeclare nopermissions:.Also registers the new pages in
mkdocs.ymlunder a new Security nav section — which incidentally de-orphans the existingdocs/security/selector_resource_limits.mdpage — and links them fromdocs/README.md,SECURITY.mdandCONTRIBUTING.md.Docs-only change: no Go code is touched.
make checks,make lintandmkdocs build --strictall pass locally.Fixes #1626