enforce

package

v0.0.0-...-3d71f35 Latest Latest Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 14 Imported by: 1

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

Repository

github.com/ossf/allstar

Links

Open Source Insights

Documentation ¶

Overview ¶

Package enforce is a central engine to Allstar that contains various enforcement logic.

Index ¶

func EnforceJob(ctx context.Context, ghc *ghclients.GHClients, d time.Duration, ...) error
type EnforceAllResults
- func EnforceAll(ctx context.Context, ghc ghclients.GhClientsInterface, ...) (EnforceAllResults, error)
type EnforceRepoResults

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func EnforceJob ¶

func EnforceJob(ctx context.Context, ghc *ghclients.GHClients, d time.Duration, specificPolicyArg string, specificRepoArg string) error

EnforceJob is a reconciliation job that enforces policies on all repos every d duration. It runs forever until the context is done.

Types ¶

type EnforceAllResults ¶

type EnforceAllResults = map[string]map[string]int

func EnforceAll ¶

func EnforceAll(ctx context.Context, ghc ghclients.GhClientsInterface, specificPolicyArg string, specificRepoArg string) (EnforceAllResults, error)

EnforceAll iterates through all available installations and repos Allstar has access to and runs policies on those repos. It is meant to be a reconciliation job to check repos which a webhook event may have been lost.

TBD: determine if this should remain exported, or if it will only be called from EnforceJob.

type EnforceRepoResults ¶

type EnforceRepoResults = map[string]bool

Source Files ¶

View all Source files

enforce.go

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