policy

package

v0.1.0-alpha.30 Latest Latest Go to latest Published: Feb 28, 2024 License: MPL-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package policy provides base policy definitions.

This section is empty.

This section is empty.

This section is empty.

type Check interface {
	Name() string
	Message() string
	Errors() []error
}

Check defines a policy check.

type Option func(*Options)

Option is a functional option used to pass in arguments to a Policy.

func WithCommitMsgFile(o *string) Option

WithCommitMsgFile sets the path to the commit message file.

func WithCommitRef(o string) Option

WithCommitRef sets the ref to compare git policies against.

func WithRevisionRange(o string) Option

WithRevisionRange sets the revision range to compare git policies against.

type Options struct {
	CommitMsgFile *string
	CommitRef     string
	RevisionRange string
}

Options defines the set of options available to a Policy.

func NewDefaultOptions(setters ...Option) *Options

NewDefaultOptions initializes a Options struct with default values.

type Policy interface {
	Compliance(*Options) (*Report, error)
}

Policy is an interface that policies must implement.

type Report struct {
	// contains filtered or unexported fields
}

Report reports the compliance of a policy.

func (r *Report) AddCheck(c Check)

AddCheck adds a check to the policy report.

func (r *Report) Checks() []Check

Checks returns the checks executed by a policy.

func (r *Report) Valid() bool

Valid checks if a report is valid.

Path	Synopsis
commit Package commit provides commit-related policies.	Package commit provides commit-related policies.
license Package license provides license policy.	Package license provides license policy.
version Package version provides version policies.	Package version provides version policies.