enforce

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

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