Skip to content

docs(security): sync .bestpractices.json to live passing state (drop vestigial _url keys)#123

Merged
aksOps merged 1 commit into
mainfrom
docs/bestpractices-sync-passing
Jun 18, 2026
Merged

docs(security): sync .bestpractices.json to live passing state (drop vestigial _url keys)#123
aksOps merged 1 commit into
mainfrom
docs/bestpractices-sync-passing

Conversation

@aksOps

@aksOps aksOps commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

What

Reconcile the repo .bestpractices.json golden source against the live passing
OpenSSF record (https://www.bestpractices.dev/projects/12646.json, now
badge_level=passing, 100%).

  • Drop 29 vestigial per-criterion <crit>_url keys. The live record has no
    per-criterion URL field — only the top-level homepage_url/repo_url/badge_url/
    project_page_url (all kept). This settles it: the URL must be inline in the
    justification, which it is for all 8 url-required criteria (PR docs(security): embed required URLs inline in .bestpractices.json justifications #122).
  • Correct _comment to document that (no separate per-criterion URL field).
  • report_archive link simplified to /issues to match the live value.
  • self_assessment_date → 2026-06-18.

Deliberately not done

Did not overwrite our richer, project-specific justifications with
bestpractices.dev's auto-generated boilerplate (e.g. "Some documentation basics
file contents found.") or re-introduce the stray [osps_br_03_02] tag the live
delivery_mitm entry still carries. Both forms validate; ours are better and the
badge stays passing. (A literal byte-for-byte mirror is available on request.)

Verification

  • 8 url-required justifications all still carry an inline https:// link.
  • per_crit_url=0, 4 top-level URL metadata fields retained, level=passing.
  • JSON validates; diff is 3 insertions, 32 deletions.

🤖 Generated with Claude Code
https://claude.ai/code/session_01LDQVJrixs2nJoea67a8pEG

The live OpenSSF record (https://www.bestpractices.dev/projects/12646.json)
is now passing (badge_level=passing, 100%). Reconcile the repo golden source
to match the authoritative live schema:

- Drop 29 vestigial per-criterion <crit>_url keys. The live record has NO
  per-criterion URL field (only the top-level homepage_url / repo_url /
  badge_url / project_page_url), confirming the URL must live inline in the
  justification -- which it now does for all url-required criteria (PR #122).
  The 4 real top-level URL metadata fields are kept.
- Correct _comment to document the inline-URL reality (no separate per-criterion
  URL field) and drop the false "<key>_url where required" clause.
- Simplify report_archive link to /issues to match the live passing value.
- Refresh self_assessment_date to 2026-06-18.

Kept our richer project-specific justifications rather than overwriting them
with bestpractices.dev's auto-generated boilerplate (and a stray OSPS tag);
both validate and the badge stays passing.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LDQVJrixs2nJoea67a8pEG
@sonarqubecloud

Copy link
Copy Markdown

@aksOps aksOps merged commit 56d4e91 into main Jun 18, 2026
17 checks passed
@aksOps aksOps deleted the docs/bestpractices-sync-passing branch June 18, 2026 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant