badgeurl

package

v0.24.0 Latest Latest Go to latest Published: May 30, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ossf/pvtr-github-repo-scanner

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Generate(content []byte, options Options) ([]string, error)
func GenerateFromFile(path string, options Options) ([]string, error)
type Options

Constants ¶

View Source

const (
	// DefaultBadge lets bestpractices.dev prompt the user to choose a target
	// baseline section after opening the generated edit URL.
	DefaultBadge = "choose"
)

Variables ¶

This section is empty.

Functions ¶

func Generate ¶

func Generate(content []byte, options Options) ([]string, error)

Generate converts a serialized Privateer results document into one or more Best Practices Badge automation-proposals URLs. Reference: https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/automation-proposals.md

func GenerateFromFile ¶

func GenerateFromFile(path string, options Options) ([]string, error)

GenerateFromFile reads a serialized Privateer results file and returns one or more Best Practices Badge automation proposal URLs.

Types ¶

type Options ¶

type Options struct {
	Badge                 string
	IncludeJustifications *bool
}

Options configures badge URL generation.

IncludeJustifications is a tri-state field: nil applies the package default of including justifications, while non-nil values explicitly enable or disable them.

Source Files ¶

View all Source files

badgeurl.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL