Documentation
¶
Overview ¶
Package workflow provides discovery and parsing of GitHub Actions workflow files.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type File ¶ added in v1.0.1
File represents a parsed GitHub Actions workflow file.
func (File) GetInputs ¶ added in v1.0.1
GetInputs returns the workflow inputs, or empty map if none.
func (File) IsDispatchable ¶ added in v1.0.1
IsDispatchable returns true if the workflow has workflow_dispatch trigger.
type Input ¶ added in v1.0.1
type Input struct {
Description string `yaml:"description"`
Default string `yaml:"default"`
Type string `yaml:"type"`
Options []string `yaml:"options"`
ValidationRules []rule.ValidationRule `yaml:"-"`
Required bool `yaml:"required"`
}
Input represents a single input definition for workflow_dispatch.
type OnTrigger ¶
type OnTrigger struct {
//nolint:tagliatelle // matches GitHub Actions workflow YAML schema
Dispatch *Dispatch `yaml:"workflow_dispatch"`
}
OnTrigger represents the "on" field which can trigger workflows.
type ParseFailure ¶ added in v1.2.0
ParseFailure names a workflow file that could not be read or parsed. A repository holding only these looks identical to an empty one unless the failures are reported alongside the workflows.
Click to show internal directories.
Click to hide internal directories.