vcs

Documentation

Index

• Constants
• type Actions
  • func BuildId(version string) *Actions
• type Context
• type ContextEnvironment
  • func BuildEnvironment(context *GithubContext, runner *RunnerContext, ...) ContextEnvironment
  • func CreateGithubCIEnvironment(githubContext []byte, runnerContext, envsContext *string) (ContextEnvironment, error)
  • func ResolveBuildContext(context, runner, env *string) (ContextEnvironment, error)
• type ContextType
  • func (in ContextType) Hosted() bool
  • func (in ContextType) String() string
• type CurrentBuildEnvironment
  • func ParseBuild(envs *string) (*CurrentBuildEnvironment, error)
  • func (in *CurrentBuildEnvironment) FilterEnvs() map[string]string
  • func (in *CurrentBuildEnvironment) GetEnvs() map[string]string
• type Event
  • func ParseEvent(inputs []byte) (*Event, error)
  • func (in *Event) GetHeadCommitTimestamp() string
• type EventMetadata
• type Github
• type GithubCIEnvironment
  • func (in *GithubCIEnvironment) BuildInvocationId() string
  • func (in *GithubCIEnvironment) BuildType() string
  • func (in *GithubCIEnvironment) BuilderId() string
  • func (in *GithubCIEnvironment) Context() string
  • func (in *GithubCIEnvironment) CurrentFilteredEnvironment() map[string]string
  • func (in *GithubCIEnvironment) GetEvent() *Event
  • func (in *GithubCIEnvironment) NonReproducibleMetadata() *Metadata
  • func (in *GithubCIEnvironment) RepoUri() string
  • func (in *GithubCIEnvironment) Sha() string
  • func (in *GithubCIEnvironment) UserDefinedParameters() *Event
• type GithubContext
  • func ParseContext(github []byte) (*GithubContext, error)
• type HeadCommit
• type Metadata
• type PullRequest
• type Runner
• type RunnerContext
  • func ParseRunner(runner *string) (*RunnerContext, error)
• type WorkFlow

Constants

const (
	GithubActionsBuildIdVersion = "v1"
)

Types

type Actions

type Actions struct {
	HostedIdSuffix     string
	SelfHostedIdSuffix string
	BuildType          string
}

func BuildId

func BuildId(version string) *Actions

BuildId The GitHub Actions team has not yet reviewed or approved this design, and it is not yet implemented. Details are subject to change!

type Context

type Context struct {
	Github Github
	Runner Runner
}

type ContextEnvironment

type ContextEnvironment interface {
	BuilderId() string
	BuildInvocationId() string
	BuildType() string
	Context() string
	CurrentFilteredEnvironment() map[string]string
	NonReproducibleMetadata() *Metadata
	UserDefinedParameters() *Event
	RepoUri() string
	Sha() string
	GetEvent() *Event
}

func BuildEnvironment

func BuildEnvironment(context *GithubContext, runner *RunnerContext, current *CurrentBuildEnvironment, event *Event) ContextEnvironment

func CreateGithubCIEnvironment

func CreateGithubCIEnvironment(githubContext []byte, runnerContext, envsContext *string) (ContextEnvironment, error)

func ResolveBuildContext

func ResolveBuildContext(context, runner, env *string) (ContextEnvironment, error)

type ContextType

type ContextType string

const (
	ContextTypeGithub ContextType = "GITHUB_ACTIONS"
)

func (ContextType) Hosted

func (in ContextType) Hosted() bool

func (ContextType) String

func (in ContextType) String() string

type CurrentBuildEnvironment

type CurrentBuildEnvironment struct {
	Envs map[string]string
}

func ParseBuild

func ParseBuild(envs *string) (*CurrentBuildEnvironment, error)

func (*CurrentBuildEnvironment) FilterEnvs

func (in *CurrentBuildEnvironment) FilterEnvs() map[string]string

func (*CurrentBuildEnvironment) GetEnvs

func (in *CurrentBuildEnvironment) GetEnvs() map[string]string

type Event

type Event struct {
	EventMetadata *EventMetadata `json:"event"`
}

func ParseEvent

func ParseEvent(inputs []byte) (*Event, error)

func (*Event) GetHeadCommitTimestamp

func (in *Event) GetHeadCommitTimestamp() string

type EventMetadata

type EventMetadata struct {
	HeadCommit  *HeadCommit  `json:"head_commit"`
	PullRequest *PullRequest `json:"pull_request"`
	WorkFlowRun *WorkFlow    `json:"workflow_run"`
}

type Github

type Github struct {
	RunId string
}

type GithubCIEnvironment

type GithubCIEnvironment struct {
	BuildContext     *GithubContext
	Event            *Event
	RunnerContext    *RunnerContext
	BuildEnvironment *CurrentBuildEnvironment
	Actions          *Actions
}

func (*GithubCIEnvironment) BuildInvocationId

func (in *GithubCIEnvironment) BuildInvocationId() string

func (*GithubCIEnvironment) BuildType

func (in *GithubCIEnvironment) BuildType() string

func (*GithubCIEnvironment) BuilderId

func (in *GithubCIEnvironment) BuilderId() string

func (*GithubCIEnvironment) Context

func (in *GithubCIEnvironment) Context() string

func (*GithubCIEnvironment) CurrentFilteredEnvironment

func (in *GithubCIEnvironment) CurrentFilteredEnvironment() map[string]string

func (*GithubCIEnvironment) GetEvent

func (in *GithubCIEnvironment) GetEvent() *Event

func (*GithubCIEnvironment) NonReproducibleMetadata

func (in *GithubCIEnvironment) NonReproducibleMetadata() *Metadata

func (*GithubCIEnvironment) RepoUri

func (in *GithubCIEnvironment) RepoUri() string

func (*GithubCIEnvironment) Sha

func (in *GithubCIEnvironment) Sha() string

func (*GithubCIEnvironment) UserDefinedParameters

func (in *GithubCIEnvironment) UserDefinedParameters() *Event

type GithubContext

type GithubContext struct {
	Action          string          `json:"action"`
	Actor           string          `json:"actor"`
	Event           json.RawMessage `json:"event"`
	EventName       string          `json:"event_name"`
	EventPath       string          `json:"event_path"`
	Job             string          `json:"job"`
	Ref             string          `json:"ref"`
	Repository      string          `json:"repository"`
	RepositoryOwner string          `json:"repository_owner"`
	RunId           string          `json:"run_id"`
	RunNumber       string          `json:"run_number"`
	ServerUrl       string          `json:"server_url"`
	SHA             string          `json:"sha"`
	Token           string          `json:"token,omitempty"`
	Workflow        string          `json:"workflow"`
	Workspace       string          `json:"workspace"`
}

func ParseContext

func ParseContext(github []byte) (*GithubContext, error)

type HeadCommit

type HeadCommit struct {
	Timestamp string `json:"timestamp"`
}

type Metadata

type Metadata struct {
	Arch    string            `json:"arch"`
	Env     map[string]string `json:"env"`
	Context Context           `json:"context"`
}

type PullRequest

type PullRequest struct {
	UpdatedAt string `json:"updated_at"`
}

type Runner

type Runner struct {
	Os   string
	Temp string
}

type RunnerContext

type RunnerContext struct {
	Name      string `json:"name"`
	Arch      string `json:"arch"`
	OS        string `json:"os"`
	Temp      string `json:"temp"`
	ToolCache string `json:"tool_cache"`
}

func ParseRunner

func ParseRunner(runner *string) (*RunnerContext, error)

type WorkFlow

type WorkFlow struct {
	HeadCommit *HeadCommit `json:"head_commit"`
}