githubActions

Documentation

Index

• func Prepare(filename string) (runner.Run, error)
• type Job
• type Step
• type Workflow
  • func (w Workflow) MakeRun() (runner.Run, error)

Functions

func Prepare

func Prepare(filename string) (runner.Run, error)

Types

type Job

type Job struct {
	Name      string `yaml:"name"`
	RunsOn    string `yaml:"runs-on"`
	Container string `yaml:"container"`
	Steps     []Step `yaml:"steps"`
}

each job in the workflow

type Step

type Step struct {
	Name string `yaml:"name"`
	Run  string `yaml:"run"`
	Uses string `yaml:"uses"`
}

each step in a job

type Workflow

type Workflow struct {
	Name string         `yaml:"name"`
	On   string         `yaml:"on"`
	Jobs map[string]Job `yaml:"jobs"`
}

the entire workflow

func (Workflow) MakeRun

func (w Workflow) MakeRun() (runner.Run, error)