cistarlark

Documentation

Index

• func ConvertToWorkflow(v starlark.Value) (*workflow.Workflow, error)
• func DefaultBuiltIns() map[string]starlark.StringDict
• func LoadWorkflow(ctx context.Context, hc *http.Client, fn string, ciContext WorkflowContext, ...) (*workflow.Workflow, error)
• func MakeLoad(src modOpener) func(thread *starlark.Thread, module string) (starlark.StringDict, error)
• type Config
• type GithubEvent
• type PrintFunc
• type WorkflowContext

Functions

func ConvertToWorkflow

func ConvertToWorkflow(v starlark.Value) (*workflow.Workflow, error)

func DefaultBuiltIns

func DefaultBuiltIns() map[string]starlark.StringDict

func LoadWorkflow

func LoadWorkflow(ctx context.Context, hc *http.Client, fn string, ciContext WorkflowContext, cfg Config) (*workflow.Workflow, error)

func MakeLoad

func MakeLoad(src modOpener) func(thread *starlark.Thread, module string) (starlark.StringDict, error)

Types

type Config

type Config struct {
	// BuiltIns modules loaded via the "builtin:///"
	BuiltIns map[string]starlark.StringDict
	// Predeclared global variables
	Predeclared starlark.StringDict
	// Print function for user feedback
	Print PrintFunc
}

type GithubEvent

type GithubEvent interface {
	GetInstallation() *github.Installation
	GetRepo() *github.Repository
	GetSender() *github.User
}

type PrintFunc

type PrintFunc func(_ *starlark.Thread, msg string)

type WorkflowContext

type WorkflowContext struct {
	Repo        *github.Repository
	Entrypoint  string
	Ref         string
	RefType     string
	SHA         string
	ContextData map[string]string
	PRs         []*github.PullRequest
	Event       GithubEvent
}