workflow

Documentation

Overview

Package workflow provides discovery and parsing of GitHub Actions workflow files.

Index

• type Dispatch
• type File
  • func Discover(repoRoot string) ([]File, error)
  • func Parse(data []byte) (File, error)
  • func (w File) GetInputs() map[string]Input
  • func (w File) IsDispatchable() bool
• type Input
  • func (i Input) InputType() string
• type OnTrigger

Types

type Dispatch

type Dispatch struct {
	Inputs map[string]Input `yaml:"inputs"`
}

Dispatch represents the workflow_dispatch trigger configuration.

type File

type File struct {
	On       OnTrigger `yaml:"on"`
	Name     string    `yaml:"name"`
	Filename string    `yaml:"-"`
}

File represents a parsed GitHub Actions workflow file.

func Discover

func Discover(repoRoot string) ([]File, error)

Discover finds all workflow files in the .github/workflows directory and returns only those with workflow_dispatch triggers.

func Parse

func Parse(data []byte) (File, error)

Parse parses workflow YAML content into a File struct.

func (File) GetInputs

func (w File) GetInputs() map[string]Input

GetInputs returns the workflow inputs, or empty map if none.

func (File) IsDispatchable

func (w File) IsDispatchable() bool

IsDispatchable returns true if the workflow has workflow_dispatch trigger.

type Input

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.

func (Input) InputType

func (i Input) InputType() string

InputType returns the normalized input type, defaulting to "string".

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.