feat: add best practices badge URL generator#301
Open
Conversation
vinayada1
force-pushed
the
feat/best-practices-badge-url
branch
4 times, most recently
from
e540eea to
f928e37
Compare
Signed-off-by: Vinaya Damle <vinayada1@users.noreply.github.com>
vinayada1
force-pushed
the
feat/best-practices-badge-url
branch
from
f928e37 to
b090ab4
Compare
jmeridth
approved these changes
May 6, 2026
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
2 participants
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.
Summary
Add a Best Practices Badge URL generator that turns Privateer scan results into reviewable bestpractices.dev proposal links.
This change adds a small CLI for producing badge proposal URLs from scanner output, including support for badge section selection, optional justification text, and compatibility batching for environments that need shorter URLs. It also documents the user workflow in the repository so scan results can be applied through the Best Practices Badge UI with manual review.
The implementation normalizes Privateer results into Best Practices Badge statuses, preserves useful evidence text in justifications, and handles repository lookup from serialized scan payloads. Regression tests cover invalid inputs, batching behavior, default option handling, NotApplicable mapping, evidence URL preservation, and Unicode-safe justification truncation.
Limitations
This flow still depends on the current bestpractices.dev automation proposal query format and is validated locally rather than with a live end-to-end badge submission test.
Validation
go test ./...