Documentation
¶
Index ¶
- type Concurrency
- type Container
- type Job
- func (j Job) Concurrency() *Concurrency
- func (j Job) Container() *Container
- func (j Job) Env() map[string]string
- func (j Job) Environment() string
- func (j Job) HasNeed(name string) bool
- func (j Job) If() string
- func (j Job) MarshalYAML() (any, error)
- func (j Job) Name() string
- func (j Job) Needs() []string
- func (j Job) RunsOn() string
- func (j Job) Steps() []Step
- type JobOptions
- type PRTrigger
- type PushTrigger
- type Step
- type StepOptions
- type Workflow
- func (w *Workflow) Concurrency() *Concurrency
- func (w *Workflow) Env() map[string]string
- func (w *Workflow) HasNeed(jobName, dependency string) bool
- func (w *Workflow) Job(name string) (Job, bool)
- func (w *Workflow) JobCount() int
- func (w *Workflow) JobNames() []string
- func (w *Workflow) Name() string
- func (w *Workflow) On() WorkflowTrigger
- func (w *Workflow) Permissions() map[string]string
- func (w *Workflow) ToYAML() ([]byte, error)
- type WorkflowBuilder
- type WorkflowOptions
- type WorkflowTrigger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Concurrency ¶
type Job ¶
type Job struct {
// contains filtered or unexported fields
}
func NewJob ¶ added in v0.10.6
func NewJob(opts JobOptions) (Job, error)
func (Job) Concurrency ¶
func (j Job) Concurrency() *Concurrency
func (Job) Environment ¶
func (Job) MarshalYAML ¶ added in v0.10.6
type JobOptions ¶ added in v0.10.6
type PushTrigger ¶
type PushTrigger struct {
Branches []string `yaml:"branches,omitempty"`
}
type Step ¶
type Step struct {
// contains filtered or unexported fields
}
func NewStep ¶ added in v0.10.6
func NewStep(opts StepOptions) Step
func (Step) ContinueOnError ¶ added in v0.10.4
func (Step) MarshalYAML ¶ added in v0.10.6
type StepOptions ¶ added in v0.10.6
type Workflow ¶
type Workflow struct {
// contains filtered or unexported fields
}
func EmptyWorkflow ¶ added in v0.10.6
func EmptyWorkflow() *Workflow
func (*Workflow) Concurrency ¶
func (w *Workflow) Concurrency() *Concurrency
func (*Workflow) On ¶
func (w *Workflow) On() WorkflowTrigger
func (*Workflow) Permissions ¶
type WorkflowBuilder ¶ added in v0.10.6
type WorkflowBuilder struct {
// contains filtered or unexported fields
}
func NewWorkflowBuilder ¶ added in v0.10.6
func NewWorkflowBuilder(opts WorkflowOptions) *WorkflowBuilder
func (*WorkflowBuilder) AddJob ¶ added in v0.10.6
func (b *WorkflowBuilder) AddJob(name string, job Job) error
func (*WorkflowBuilder) Build ¶ added in v0.10.6
func (b *WorkflowBuilder) Build() (*Workflow, error)
type WorkflowOptions ¶ added in v0.10.6
type WorkflowOptions struct {
Name string
On WorkflowTrigger
Permissions map[string]string
Env map[string]string
Concurrency *Concurrency
}
type WorkflowTrigger ¶
type WorkflowTrigger struct {
Push *PushTrigger `yaml:"push,omitempty"`
PullRequest *PRTrigger `yaml:"pull_request,omitempty"`
WorkflowDispatch any `yaml:"workflow_dispatch,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.