permissions

Documentation

Index

• func AddWorkflowLevelPermissions(inputYaml string, addProjectComment bool, addEmptyTopLevelPermissions bool) (string, error)
• func IterateNode(node *yaml.Node, identifier, tag string, minLine int) *yaml.Node
• func ShouldAddWorkflowLevelPermissions(jobErrors []JobError) bool
• type JobError
• type JobState
• type Permission
• type SecureWorkflowReponse
  • func AddJobLevelPermissions(inputYaml string, addEmptyTopLevelPermissions bool) (*SecureWorkflowReponse, error)

Functions

func AddWorkflowLevelPermissions

func AddWorkflowLevelPermissions(inputYaml string, addProjectComment bool, addEmptyTopLevelPermissions bool) (string, error)

func IterateNode

func IterateNode(node *yaml.Node, identifier, tag string, minLine int) *yaml.Node

func ShouldAddWorkflowLevelPermissions

func ShouldAddWorkflowLevelPermissions(jobErrors []JobError) bool

Types

type JobError

type JobError struct {
	JobName string
	Errors  []string
}

type JobState

type JobState struct {
	CurrentNpmPackageRegistry string
	CurrentNuGetSourceURL     string
	CurrentNugetAuthToken     string

	WorkflowEnv       map[string]string // map of workflow level environment variables
	MissingActions    []string
	Errors            []error
	ActionPermissions *metadata.ActionPermissions
}

type Permission

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

type SecureWorkflowReponse

type SecureWorkflowReponse struct {
	OriginalInput          string
	FinalOutput            string
	IsChanged              bool
	HasErrors              bool
	AlreadyHasPermissions  bool
	AddedMaintainedActions bool
	PinnedActions          bool
	AddedHardenRunner      bool
	AddedPermissions       bool
	IncorrectYaml          bool
	WorkflowFetchError     bool
	JobErrors              []JobError
	MissingActions         []string
}

func AddJobLevelPermissions

func AddJobLevelPermissions(inputYaml string, addEmptyTopLevelPermissions bool) (*SecureWorkflowReponse, error)