Help us shape the future of Go! Take the 2026 Go Developer Survey

execpb

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	StreamKind_name = map[int32]string{
		0: "STREAM_KIND_UNSPECIFIED",
		1: "STREAM_KIND_STDOUT",
		2: "STREAM_KIND_STDERR",
	}
	StreamKind_value = map[string]int32{
		"STREAM_KIND_UNSPECIFIED": 0,
		"STREAM_KIND_STDOUT":      1,
		"STREAM_KIND_STDERR":      2,
	}
)

Enum value maps for StreamKind.

View Source
var (
	CancelKind_name = map[int32]string{
		0: "CANCEL_KIND_UNSPECIFIED",
		1: "CANCEL_KIND_USER",
		2: "CANCEL_KIND_TIMEOUT",
		3: "CANCEL_KIND_SHUTDOWN",
	}
	CancelKind_value = map[string]int32{
		"CANCEL_KIND_UNSPECIFIED": 0,
		"CANCEL_KIND_USER":        1,
		"CANCEL_KIND_TIMEOUT":     2,
		"CANCEL_KIND_SHUTDOWN":    3,
	}
)

Enum value maps for CancelKind.

View Source
var (
	AnnotationLevel_name = map[int32]string{
		0: "ANNOTATION_LEVEL_UNSPECIFIED",
		1: "ANNOTATION_LEVEL_NOTICE",
		2: "ANNOTATION_LEVEL_WARNING",
		3: "ANNOTATION_LEVEL_FAILURE",
	}
	AnnotationLevel_value = map[string]int32{
		"ANNOTATION_LEVEL_UNSPECIFIED": 0,
		"ANNOTATION_LEVEL_NOTICE":      1,
		"ANNOTATION_LEVEL_WARNING":     2,
		"ANNOTATION_LEVEL_FAILURE":     3,
	}
)

Enum value maps for AnnotationLevel.

View Source
var (
	StepConclusion_name = map[int32]string{
		0: "STEP_CONCLUSION_UNSPECIFIED",
		1: "STEP_CONCLUSION_SUCCESS",
		2: "STEP_CONCLUSION_FAILURE",
		3: "STEP_CONCLUSION_CANCELLED",
		4: "STEP_CONCLUSION_SKIPPED",
		5: "STEP_CONCLUSION_TIMED_OUT",
	}
	StepConclusion_value = map[string]int32{
		"STEP_CONCLUSION_UNSPECIFIED": 0,
		"STEP_CONCLUSION_SUCCESS":     1,
		"STEP_CONCLUSION_FAILURE":     2,
		"STEP_CONCLUSION_CANCELLED":   3,
		"STEP_CONCLUSION_SKIPPED":     4,
		"STEP_CONCLUSION_TIMED_OUT":   5,
	}
)

Enum value maps for StepConclusion.

Functions

This section is empty.

Types

type Annotation added in v0.2.0

type Annotation struct {
	Level       AnnotationLevel `protobuf:"varint,1,opt,name=level,proto3,enum=ermite.runner.exec.v1.AnnotationLevel" json:"level,omitempty"`
	Title       string          `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	Message     string          `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	File        string          `protobuf:"bytes,4,opt,name=file,proto3" json:"file,omitempty"` // relative to the repository when the file is in it
	StartLine   int32           `protobuf:"varint,5,opt,name=start_line,json=startLine,proto3" json:"start_line,omitempty"`
	EndLine     int32           `protobuf:"varint,6,opt,name=end_line,json=endLine,proto3" json:"end_line,omitempty"`
	StartColumn int32           `protobuf:"varint,7,opt,name=start_column,json=startColumn,proto3" json:"start_column,omitempty"`
	EndColumn   int32           `protobuf:"varint,8,opt,name=end_column,json=endColumn,proto3" json:"end_column,omitempty"`
	// contains filtered or unexported fields
}

Annotation is one ::notice, ::warning or ::error (or a problem matcher match), masked. The host validates every field again before it sends them.

func (*Annotation) Descriptor deprecated added in v0.2.0

func (*Annotation) Descriptor() ([]byte, []int)

Deprecated: Use Annotation.ProtoReflect.Descriptor instead.

func (*Annotation) GetEndColumn added in v0.2.0

func (x *Annotation) GetEndColumn() int32

func (*Annotation) GetEndLine added in v0.2.0

func (x *Annotation) GetEndLine() int32

func (*Annotation) GetFile added in v0.2.0

func (x *Annotation) GetFile() string

func (*Annotation) GetLevel added in v0.2.0

func (x *Annotation) GetLevel() AnnotationLevel

func (*Annotation) GetMessage added in v0.2.0

func (x *Annotation) GetMessage() string

func (*Annotation) GetStartColumn added in v0.2.0

func (x *Annotation) GetStartColumn() int32

func (*Annotation) GetStartLine added in v0.2.0

func (x *Annotation) GetStartLine() int32

func (*Annotation) GetTitle added in v0.2.0

func (x *Annotation) GetTitle() string

func (*Annotation) ProtoMessage added in v0.2.0

func (*Annotation) ProtoMessage()

func (*Annotation) ProtoReflect added in v0.2.0

func (x *Annotation) ProtoReflect() protoreflect.Message

func (*Annotation) Reset added in v0.2.0

func (x *Annotation) Reset()

func (*Annotation) String added in v0.2.0

func (x *Annotation) String() string

type AnnotationLevel added in v0.2.0

type AnnotationLevel int32
const (
	AnnotationLevel_ANNOTATION_LEVEL_UNSPECIFIED AnnotationLevel = 0
	AnnotationLevel_ANNOTATION_LEVEL_NOTICE      AnnotationLevel = 1
	AnnotationLevel_ANNOTATION_LEVEL_WARNING     AnnotationLevel = 2
	AnnotationLevel_ANNOTATION_LEVEL_FAILURE     AnnotationLevel = 3
)

func (AnnotationLevel) Descriptor added in v0.2.0

func (AnnotationLevel) Enum added in v0.2.0

func (x AnnotationLevel) Enum() *AnnotationLevel

func (AnnotationLevel) EnumDescriptor deprecated added in v0.2.0

func (AnnotationLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use AnnotationLevel.Descriptor instead.

func (AnnotationLevel) Number added in v0.2.0

func (AnnotationLevel) String added in v0.2.0

func (x AnnotationLevel) String() string

func (AnnotationLevel) Type added in v0.2.0

type Cancel

type Cancel struct {

	// reason is for the job log and diagnostics ("cancelled by the user",
	// "job timeout", ...); it never changes the behaviour.
	Reason string `protobuf:"bytes,1,opt,name=reason,proto3" json:"reason,omitempty"`
	// kind tells the job executor how the job ends: cancelled, timed out, or
	// cancelled because the runner shuts down. The stub executor ignores it.
	Kind CancelKind `protobuf:"varint,2,opt,name=kind,proto3,enum=ermite.runner.exec.v1.CancelKind" json:"kind,omitempty"`
	// contains filtered or unexported fields
}

Cancel asks the executor to stop the running script. The executor escalates like the official runner: SIGINT to the script's process group at once, SIGTERM 7.5 s later, SIGKILL 2.5 s after that.

func (*Cancel) Descriptor deprecated

func (*Cancel) Descriptor() ([]byte, []int)

Deprecated: Use Cancel.ProtoReflect.Descriptor instead.

func (*Cancel) GetKind

func (x *Cancel) GetKind() CancelKind

func (*Cancel) GetReason

func (x *Cancel) GetReason() string

func (*Cancel) ProtoMessage

func (*Cancel) ProtoMessage()

func (*Cancel) ProtoReflect

func (x *Cancel) ProtoReflect() protoreflect.Message

func (*Cancel) Reset

func (x *Cancel) Reset()

func (*Cancel) String

func (x *Cancel) String() string

type CancelKind

type CancelKind int32
const (
	CancelKind_CANCEL_KIND_UNSPECIFIED CancelKind = 0 // same as USER
	CancelKind_CANCEL_KIND_USER        CancelKind = 1
	CancelKind_CANCEL_KIND_TIMEOUT     CancelKind = 2
	CancelKind_CANCEL_KIND_SHUTDOWN    CancelKind = 3
)

func (CancelKind) Descriptor

func (CancelKind) Descriptor() protoreflect.EnumDescriptor

func (CancelKind) Enum

func (x CancelKind) Enum() *CancelKind

func (CancelKind) EnumDescriptor deprecated

func (CancelKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use CancelKind.Descriptor instead.

func (CancelKind) Number

func (x CancelKind) Number() protoreflect.EnumNumber

func (CancelKind) String

func (x CancelKind) String() string

func (CancelKind) Type

type Exit

type Exit struct {
	Code  int32  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` // set when the executor failed to run the script at all
	// contains filtered or unexported fields
}

func (*Exit) Descriptor deprecated

func (*Exit) Descriptor() ([]byte, []int)

Deprecated: Use Exit.ProtoReflect.Descriptor instead.

func (*Exit) GetCode

func (x *Exit) GetCode() int32

func (*Exit) GetError

func (x *Exit) GetError() string

func (*Exit) ProtoMessage

func (*Exit) ProtoMessage()

func (*Exit) ProtoReflect

func (x *Exit) ProtoReflect() protoreflect.Message

func (*Exit) Reset

func (x *Exit) Reset()

func (*Exit) String

func (x *Exit) String() string

type Frame

type Frame struct {

	// Types that are valid to be assigned to Body:
	//
	//	*Frame_Hello
	//	*Frame_Run
	//	*Frame_Output
	//	*Frame_Exit
	//	*Frame_Cancel
	//	*Frame_StepStarted
	//	*Frame_StepCompleted
	//	*Frame_Log
	//	*Frame_JobResult
	//	*Frame_StepAnnotations
	//	*Frame_StepSummary
	//	*Frame_ResolveRequest
	//	*Frame_ResolveResponse
	//	*Frame_Secret
	//	*Frame_Var
	Body isFrame_Body `protobuf_oneof:"body"`
	// contains filtered or unexported fields
}

Frame is the only message on the stream.

func (*Frame) Descriptor deprecated

func (*Frame) Descriptor() ([]byte, []int)

Deprecated: Use Frame.ProtoReflect.Descriptor instead.

func (*Frame) GetBody

func (x *Frame) GetBody() isFrame_Body

func (*Frame) GetCancel

func (x *Frame) GetCancel() *Cancel

func (*Frame) GetExit

func (x *Frame) GetExit() *Exit

func (*Frame) GetHello

func (x *Frame) GetHello() *Hello

func (*Frame) GetJobResult

func (x *Frame) GetJobResult() *JobResult

func (*Frame) GetLog

func (x *Frame) GetLog() *Log

func (*Frame) GetOutput

func (x *Frame) GetOutput() *Output

func (*Frame) GetResolveRequest added in v0.2.0

func (x *Frame) GetResolveRequest() *ResolveRequest

func (*Frame) GetResolveResponse added in v0.2.0

func (x *Frame) GetResolveResponse() *ResolveResponse

func (*Frame) GetRun

func (x *Frame) GetRun() *Run

func (*Frame) GetSecret added in v0.3.0

func (x *Frame) GetSecret() *NamedValue

func (*Frame) GetStepAnnotations added in v0.2.0

func (x *Frame) GetStepAnnotations() *StepAnnotations

func (*Frame) GetStepCompleted

func (x *Frame) GetStepCompleted() *StepCompleted

func (*Frame) GetStepStarted

func (x *Frame) GetStepStarted() *StepStarted

func (*Frame) GetStepSummary added in v0.2.0

func (x *Frame) GetStepSummary() *StepSummary

func (*Frame) GetVar added in v0.3.0

func (x *Frame) GetVar() *NamedValue

func (*Frame) ProtoMessage

func (*Frame) ProtoMessage()

func (*Frame) ProtoReflect

func (x *Frame) ProtoReflect() protoreflect.Message

func (*Frame) Reset

func (x *Frame) Reset()

func (*Frame) String

func (x *Frame) String() string

type Frame_Cancel

type Frame_Cancel struct {
	Cancel *Cancel `protobuf:"bytes,5,opt,name=cancel,proto3,oneof"` // host -> executor
}

type Frame_Exit

type Frame_Exit struct {
	Exit *Exit `protobuf:"bytes,4,opt,name=exit,proto3,oneof"` // executor -> host, last frame
}

type Frame_Hello

type Frame_Hello struct {
	Hello *Hello `protobuf:"bytes,1,opt,name=hello,proto3,oneof"` // executor -> host, first frame
}

type Frame_JobResult

type Frame_JobResult struct {
	JobResult *JobResult `protobuf:"bytes,9,opt,name=job_result,json=jobResult,proto3,oneof"` // executor -> host, before Exit
}

type Frame_Log

type Frame_Log struct {
	Log *Log `protobuf:"bytes,8,opt,name=log,proto3,oneof"` // executor -> host
}

type Frame_Output

type Frame_Output struct {
	Output *Output `protobuf:"bytes,3,opt,name=output,proto3,oneof"` // executor -> host
}

type Frame_ResolveRequest added in v0.2.0

type Frame_ResolveRequest struct {
	ResolveRequest *ResolveRequest `protobuf:"bytes,12,opt,name=resolve_request,json=resolveRequest,proto3,oneof"` // executor -> host
}

type Frame_ResolveResponse added in v0.2.0

type Frame_ResolveResponse struct {
	ResolveResponse *ResolveResponse `protobuf:"bytes,13,opt,name=resolve_response,json=resolveResponse,proto3,oneof"` // host -> executor, answers a ResolveRequest
}

type Frame_Run

type Frame_Run struct {
	Run *Run `protobuf:"bytes,2,opt,name=run,proto3,oneof"` // host -> executor, after Hello
}

type Frame_Secret added in v0.3.0

type Frame_Secret struct {
	Secret *NamedValue `protobuf:"bytes,14,opt,name=secret,proto3,oneof"` // host -> executor, one per secret, before Run
}

type Frame_StepAnnotations added in v0.2.0

type Frame_StepAnnotations struct {
	StepAnnotations *StepAnnotations `protobuf:"bytes,10,opt,name=step_annotations,json=stepAnnotations,proto3,oneof"` // executor -> host, before the StepCompleted of the step
}

type Frame_StepCompleted

type Frame_StepCompleted struct {
	StepCompleted *StepCompleted `protobuf:"bytes,7,opt,name=step_completed,json=stepCompleted,proto3,oneof"` // executor -> host
}

type Frame_StepStarted

type Frame_StepStarted struct {
	StepStarted *StepStarted `protobuf:"bytes,6,opt,name=step_started,json=stepStarted,proto3,oneof"` // executor -> host
}

type Frame_StepSummary added in v0.2.0

type Frame_StepSummary struct {
	StepSummary *StepSummary `protobuf:"bytes,11,opt,name=step_summary,json=stepSummary,proto3,oneof"` // executor -> host, before the StepCompleted of the step
}

type Frame_Var added in v0.3.0

type Frame_Var struct {
	Var *NamedValue `protobuf:"bytes,15,opt,name=var,proto3,oneof"` // host -> executor, one per variable, before Run
}

type Hello

type Hello struct {
	Version  string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // runner version of the executor
	Sandbox  string `protobuf:"bytes,2,opt,name=sandbox,proto3" json:"sandbox,omitempty"` // "vm" or "container"
	Hostname string `protobuf:"bytes,3,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// contains filtered or unexported fields
}

func (*Hello) Descriptor deprecated

func (*Hello) Descriptor() ([]byte, []int)

Deprecated: Use Hello.ProtoReflect.Descriptor instead.

func (*Hello) GetHostname

func (x *Hello) GetHostname() string

func (*Hello) GetSandbox

func (x *Hello) GetSandbox() string

func (*Hello) GetVersion

func (x *Hello) GetVersion() string

func (*Hello) ProtoMessage

func (*Hello) ProtoMessage()

func (*Hello) ProtoReflect

func (x *Hello) ProtoReflect() protoreflect.Message

func (*Hello) Reset

func (x *Hello) Reset()

func (*Hello) String

func (x *Hello) String() string

type JobResult

type JobResult struct {
	Conclusion     StepConclusion    `protobuf:"varint,1,opt,name=conclusion,proto3,enum=ermite.runner.exec.v1.StepConclusion" json:"conclusion,omitempty"`
	Outputs        map[string]string `` /* 141-byte string literal not displayed */
	Error          string            `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	RunnerShutdown bool              `protobuf:"varint,4,opt,name=runner_shutdown,json=runnerShutdown,proto3" json:"runner_shutdown,omitempty"`
	// contains filtered or unexported fields
}

JobResult is the outcome of the job; Exit follows.

func (*JobResult) Descriptor deprecated

func (*JobResult) Descriptor() ([]byte, []int)

Deprecated: Use JobResult.ProtoReflect.Descriptor instead.

func (*JobResult) GetConclusion

func (x *JobResult) GetConclusion() StepConclusion

func (*JobResult) GetError

func (x *JobResult) GetError() string

func (*JobResult) GetOutputs

func (x *JobResult) GetOutputs() map[string]string

func (*JobResult) GetRunnerShutdown

func (x *JobResult) GetRunnerShutdown() bool

func (*JobResult) ProtoMessage

func (*JobResult) ProtoMessage()

func (*JobResult) ProtoReflect

func (x *JobResult) ProtoReflect() protoreflect.Message

func (*JobResult) Reset

func (x *JobResult) Reset()

func (*JobResult) String

func (x *JobResult) String() string

type JobSpec

type JobSpec struct {
	WorkflowPath   string `protobuf:"bytes,1,opt,name=workflow_path,json=workflowPath,proto3" json:"workflow_path,omitempty"`
	WorkflowYaml   string `protobuf:"bytes,2,opt,name=workflow_yaml,json=workflowYaml,proto3" json:"workflow_yaml,omitempty"`
	JobKey         string `protobuf:"bytes,3,opt,name=job_key,json=jobKey,proto3" json:"job_key,omitempty"`
	Matrix         string `protobuf:"bytes,4,opt,name=matrix,proto3" json:"matrix,omitempty"`     // JSON object
	Contexts       string `protobuf:"bytes,5,opt,name=contexts,proto3" json:"contexts,omitempty"` // JSON object
	Repo           string `protobuf:"bytes,6,opt,name=repo,proto3" json:"repo,omitempty"`         // repository name
	TimeoutMinutes int32  `protobuf:"varint,7,opt,name=timeout_minutes,json=timeoutMinutes,proto3" json:"timeout_minutes,omitempty"`
	RunnerName     string `protobuf:"bytes,8,opt,name=runner_name,json=runnerName,proto3" json:"runner_name,omitempty"`
	RunnerVersion  string `protobuf:"bytes,9,opt,name=runner_version,json=runnerVersion,proto3" json:"runner_version,omitempty"`
	// runner_environment is the runner.environment value ("github-hosted" or "self-hosted").
	RunnerEnvironment string `protobuf:"bytes,10,opt,name=runner_environment,json=runnerEnvironment,proto3" json:"runner_environment,omitempty"`
	Debug             bool   `protobuf:"varint,11,opt,name=debug,proto3" json:"debug,omitempty"` // ACTIONS_STEP_DEBUG
	// deadline_ms is what is left of the job timeout when the host sends this
	// Run, in milliseconds: the timeout counts from the moment the host received
	// the job (runner.proto: Job.timeout_minutes), not from the start of the
	// executor, and booting the sandbox takes time. 0 means "use
	// timeout_minutes from now".
	DeadlineMs int64 `protobuf:"varint,12,opt,name=deadline_ms,json=deadlineMs,proto3" json:"deadline_ms,omitempty"`
	// send_annotations and send_summaries say that the server keeps annotations
	// (feature ci.annotations) and step summaries (ci.summaries). The executor
	// sends StepAnnotations and StepSummary frames only when they are set.
	SendAnnotations bool `protobuf:"varint,13,opt,name=send_annotations,json=sendAnnotations,proto3" json:"send_annotations,omitempty"`
	SendSummaries   bool `protobuf:"varint,14,opt,name=send_summaries,json=sendSummaries,proto3" json:"send_summaries,omitempty"`
	// cache_port and cache_token, when set, are the runner's cache service for
	// this job. The service is not on the network: the executor starts a relay
	// on the sandbox's own loopback, 127.0.0.1:<cache_port>, that carries each
	// connection over the host channel (a vsock port, or a Unix socket next to
	// the executor's) to the service. The executor gives
	// ACTIONS_CACHE_URL=http://127.0.0.1:<port>/ and the token as
	// ACTIONS_RUNTIME_TOKEN to node and docker actions only, as the official
	// runner does, and masks the token. The token is not an ermite credential: it
	// is a JWT (HS256) that only the runner's runtime services accept, scoped to
	// this job's repository and refs (and its run, see results).
	CachePort  uint32 `protobuf:"varint,15,opt,name=cache_port,json=cachePort,proto3" json:"cache_port,omitempty"`
	CacheToken string `protobuf:"bytes,16,opt,name=cache_token,json=cacheToken,proto3" json:"cache_token,omitempty"`
	// secrets_withheld is set by the host when the server sends Job.trusted and
	// the job is not trusted (feature ci.secrets): "Set up job" then says that
	// secrets are not available. Never set for servers without the feature, for
	// which an absent Job.trusted only means "not sent".
	SecretsWithheld bool `protobuf:"varint,19,opt,name=secrets_withheld,json=secretsWithheld,proto3" json:"secrets_withheld,omitempty"`
	// id_token_url and id_token_request_token are Job.id_token_url and
	// Job.id_token_request_token: the OIDC token endpoint of the server, its
	// origin rewritten as for github.server_url, and the bearer for it. The
	// executor gives them as ACTIONS_ID_TOKEN_REQUEST_URL and
	// ACTIONS_ID_TOKEN_REQUEST_TOKEN to run steps, node actions and docker
	// actions (ScriptHandler.cs:315-319, NodeScriptActionHandler.cs:66-70,
	// ContainerActionHandler.cs:232-236), and masks the token before anything
	// runs. Both are set or neither. (21 and 22 are taken by the artifacts
	// branch.)
	IdTokenUrl          string `protobuf:"bytes,23,opt,name=id_token_url,json=idTokenUrl,proto3" json:"id_token_url,omitempty"`
	IdTokenRequestToken string `protobuf:"bytes,24,opt,name=id_token_request_token,json=idTokenRequestToken,proto3" json:"id_token_request_token,omitempty"`
	// token_permissions are the effective permissions of the job's GITHUB_TOKEN
	// as the server sent them (Job.permissions, feature ci.secrets): "Set up job"
	// prints them instead of working them out from the workflow. Unset when the
	// server sent none (an older server): the executor then reads them from the
	// workflow.
	TokenPermissions *TokenPermissions `protobuf:"bytes,20,opt,name=token_permissions,json=tokenPermissions,proto3" json:"token_permissions,omitempty"`
	// cache_mode is ACTIONS_CACHE_MODE of the node and docker actions: "write"
	// when the job's cache scope has a write ref, "read" when it has none. Unset
	// without a cache service, and unset when the channel serves the results
	// service only (results set, no cache scope): no ACTIONS_CACHE_URL then.
	CacheMode string `protobuf:"bytes,21,opt,name=cache_mode,json=cacheMode,proto3" json:"cache_mode,omitempty"`
	// results says that the service behind cache_port also serves artifacts
	// (Twirp github.actions.results.api.v1.ArtifactService and its blobs) and
	// that cache_token carries the job's Actions.Results scope. The executor
	// then gives node and docker actions ACTIONS_RESULTS_URL (the same origin as
	// ACTIONS_CACHE_URL) and sets GITHUB_SERVER_URL to a *.ghe.localhost host in
	// the process of the node steps of the artifact actions only (README,
	// "Artifacts"). Set only when the server has the feature ci.artifacts.
	Results bool `protobuf:"varint,22,opt,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

JobSpec is the job to run: the fields of the job that ermite handed to the host process, minus the tokens (the sandbox never sees them).

func (*JobSpec) Descriptor deprecated

func (*JobSpec) Descriptor() ([]byte, []int)

Deprecated: Use JobSpec.ProtoReflect.Descriptor instead.

func (*JobSpec) GetCacheMode added in v0.4.0

func (x *JobSpec) GetCacheMode() string

func (*JobSpec) GetCachePort added in v0.3.0

func (x *JobSpec) GetCachePort() uint32

func (*JobSpec) GetCacheToken added in v0.3.0

func (x *JobSpec) GetCacheToken() string

func (*JobSpec) GetContexts

func (x *JobSpec) GetContexts() string

func (*JobSpec) GetDeadlineMs

func (x *JobSpec) GetDeadlineMs() int64

func (*JobSpec) GetDebug

func (x *JobSpec) GetDebug() bool

func (*JobSpec) GetIdTokenRequestToken added in v0.4.0

func (x *JobSpec) GetIdTokenRequestToken() string

func (*JobSpec) GetIdTokenUrl added in v0.4.0

func (x *JobSpec) GetIdTokenUrl() string

func (*JobSpec) GetJobKey

func (x *JobSpec) GetJobKey() string

func (*JobSpec) GetMatrix

func (x *JobSpec) GetMatrix() string

func (*JobSpec) GetRepo

func (x *JobSpec) GetRepo() string

func (*JobSpec) GetResults added in v0.4.0

func (x *JobSpec) GetResults() bool

func (*JobSpec) GetRunnerEnvironment

func (x *JobSpec) GetRunnerEnvironment() string

func (*JobSpec) GetRunnerName

func (x *JobSpec) GetRunnerName() string

func (*JobSpec) GetRunnerVersion

func (x *JobSpec) GetRunnerVersion() string

func (*JobSpec) GetSecretsWithheld added in v0.3.0

func (x *JobSpec) GetSecretsWithheld() bool

func (*JobSpec) GetSendAnnotations added in v0.2.0

func (x *JobSpec) GetSendAnnotations() bool

func (*JobSpec) GetSendSummaries added in v0.2.0

func (x *JobSpec) GetSendSummaries() bool

func (*JobSpec) GetTimeoutMinutes

func (x *JobSpec) GetTimeoutMinutes() int32

func (*JobSpec) GetTokenPermissions added in v0.3.0

func (x *JobSpec) GetTokenPermissions() *TokenPermissions

func (*JobSpec) GetWorkflowPath

func (x *JobSpec) GetWorkflowPath() string

func (*JobSpec) GetWorkflowYaml

func (x *JobSpec) GetWorkflowYaml() string

func (*JobSpec) ProtoMessage

func (*JobSpec) ProtoMessage()

func (*JobSpec) ProtoReflect

func (x *JobSpec) ProtoReflect() protoreflect.Message

func (*JobSpec) Reset

func (x *JobSpec) Reset()

func (*JobSpec) String

func (x *JobSpec) String() string

type Log

type Log struct {
	Step      int32  `protobuf:"varint,1,opt,name=step,proto3" json:"step,omitempty"`
	UnixNano  int64  `protobuf:"varint,2,opt,name=unix_nano,json=unixNano,proto3" json:"unix_nano,omitempty"`
	Text      string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	Continued bool   `protobuf:"varint,4,opt,name=continued,proto3" json:"continued,omitempty"`
	// contains filtered or unexported fields
}

Log is one line of the job log, without terminator, valid UTF-8. A line of more than 64 KiB is cut by the executor into pieces at character boundaries; every piece but the first has continued set (the AppendLog rule).

func (*Log) Descriptor deprecated

func (*Log) Descriptor() ([]byte, []int)

Deprecated: Use Log.ProtoReflect.Descriptor instead.

func (*Log) GetContinued

func (x *Log) GetContinued() bool

func (*Log) GetStep

func (x *Log) GetStep() int32

func (*Log) GetText

func (x *Log) GetText() string

func (*Log) GetUnixNano

func (x *Log) GetUnixNano() int64

func (*Log) ProtoMessage

func (*Log) ProtoMessage()

func (*Log) ProtoReflect

func (x *Log) ProtoReflect() protoreflect.Message

func (*Log) Reset

func (x *Log) Reset()

func (*Log) String

func (x *Log) String() string

type NamedValue added in v0.3.0

type NamedValue struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

NamedValue is one secret (Job.secrets) or one variable (Job.vars) of the job. They travel in frames of their own, before Run, rather than in JobSpec: a frame is at most 2 MiB (execstream.MaxFrame) and ermite allows many secrets of 48 KiB, so a map in Run could not carry them. The executor keeps them until Run arrives. Secrets are never logged nor written to disk.

func (*NamedValue) Descriptor deprecated added in v0.3.0

func (*NamedValue) Descriptor() ([]byte, []int)

Deprecated: Use NamedValue.ProtoReflect.Descriptor instead.

func (*NamedValue) GetName added in v0.3.0

func (x *NamedValue) GetName() string

func (*NamedValue) GetValue added in v0.3.0

func (x *NamedValue) GetValue() string

func (*NamedValue) ProtoMessage added in v0.3.0

func (*NamedValue) ProtoMessage()

func (*NamedValue) ProtoReflect added in v0.3.0

func (x *NamedValue) ProtoReflect() protoreflect.Message

func (*NamedValue) Reset added in v0.3.0

func (x *NamedValue) Reset()

func (*NamedValue) String added in v0.3.0

func (x *NamedValue) String() string

type Output

type Output struct {
	Stream   StreamKind `protobuf:"varint,1,opt,name=stream,proto3,enum=ermite.runner.exec.v1.StreamKind" json:"stream,omitempty"`
	Data     []byte     `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	UnixNano int64      `protobuf:"varint,3,opt,name=unix_nano,json=unixNano,proto3" json:"unix_nano,omitempty"`
	// contains filtered or unexported fields
}

func (*Output) Descriptor deprecated

func (*Output) Descriptor() ([]byte, []int)

Deprecated: Use Output.ProtoReflect.Descriptor instead.

func (*Output) GetData

func (x *Output) GetData() []byte

func (*Output) GetStream

func (x *Output) GetStream() StreamKind

func (*Output) GetUnixNano

func (x *Output) GetUnixNano() int64

func (*Output) ProtoMessage

func (*Output) ProtoMessage()

func (*Output) ProtoReflect

func (x *Output) ProtoReflect() protoreflect.Message

func (*Output) Reset

func (x *Output) Reset()

func (*Output) String

func (x *Output) String() string

type ResolveRequest added in v0.2.0

type ResolveRequest struct {
	Id   int64    `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Uses []string `protobuf:"bytes,2,rep,name=uses,proto3" json:"uses,omitempty"` // "owner/repo[/path]@ref", at most 100
	// contains filtered or unexported fields
}

ResolveRequest asks the host to resolve actions with RunnerService. ResolveActions: the job token stays in the host, so the executor cannot call it. The executor sends one per level of composite actions (the runner's own "one more round per level") and waits for the ResolveResponse with the same id.

func (*ResolveRequest) Descriptor deprecated added in v0.2.0

func (*ResolveRequest) Descriptor() ([]byte, []int)

Deprecated: Use ResolveRequest.ProtoReflect.Descriptor instead.

func (*ResolveRequest) GetId added in v0.2.0

func (x *ResolveRequest) GetId() int64

func (*ResolveRequest) GetUses added in v0.2.0

func (x *ResolveRequest) GetUses() []string

func (*ResolveRequest) ProtoMessage added in v0.2.0

func (*ResolveRequest) ProtoMessage()

func (*ResolveRequest) ProtoReflect added in v0.2.0

func (x *ResolveRequest) ProtoReflect() protoreflect.Message

func (*ResolveRequest) Reset added in v0.2.0

func (x *ResolveRequest) Reset()

func (*ResolveRequest) String added in v0.2.0

func (x *ResolveRequest) String() string

type ResolveResponse added in v0.2.0

type ResolveResponse struct {
	Id      int64             `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Error   string            `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	Actions []*ResolvedAction `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

ResolveResponse answers a ResolveRequest. error is set when the call itself failed (the executor fails the job); actions has one entry per uses otherwise.

func (*ResolveResponse) Descriptor deprecated added in v0.2.0

func (*ResolveResponse) Descriptor() ([]byte, []int)

Deprecated: Use ResolveResponse.ProtoReflect.Descriptor instead.

func (*ResolveResponse) GetActions added in v0.2.0

func (x *ResolveResponse) GetActions() []*ResolvedAction

func (*ResolveResponse) GetError added in v0.2.0

func (x *ResolveResponse) GetError() string

func (*ResolveResponse) GetId added in v0.2.0

func (x *ResolveResponse) GetId() int64

func (*ResolveResponse) ProtoMessage added in v0.2.0

func (*ResolveResponse) ProtoMessage()

func (*ResolveResponse) ProtoReflect added in v0.2.0

func (x *ResolveResponse) ProtoReflect() protoreflect.Message

func (*ResolveResponse) Reset added in v0.2.0

func (x *ResolveResponse) Reset()

func (*ResolveResponse) String added in v0.2.0

func (x *ResolveResponse) String() string

type ResolvedAction added in v0.2.0

type ResolvedAction struct {
	Ref           string `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	NameWithOwner string `protobuf:"bytes,2,opt,name=name_with_owner,json=nameWithOwner,proto3" json:"name_with_owner,omitempty"`
	Path          string `protobuf:"bytes,3,opt,name=path,proto3" json:"path,omitempty"`
	ResolvedSha   string `protobuf:"bytes,4,opt,name=resolved_sha,json=resolvedSha,proto3" json:"resolved_sha,omitempty"`
	TarballUrl    string `protobuf:"bytes,5,opt,name=tarball_url,json=tarballUrl,proto3" json:"tarball_url,omitempty"`
	Token         string `protobuf:"bytes,6,opt,name=token,proto3" json:"token,omitempty"`
	Source        string `protobuf:"bytes,7,opt,name=source,proto3" json:"source,omitempty"`
	Error         string `protobuf:"bytes,8,opt,name=error,proto3" json:"error,omitempty"`
	// auth_origin (scheme://host[:port], as the sandbox reaches it) is the only
	// origin the token may be sent to; empty means the token is never sent. The
	// host sets it for archives served by the ermite server, from its own
	// configuration, never from the URL alone.
	AuthOrigin string `protobuf:"bytes,9,opt,name=auth_origin,json=authOrigin,proto3" json:"auth_origin,omitempty"`
	// contains filtered or unexported fields
}

ResolvedAction mirrors ermite.ResolvedAction (the token is a secret: the executor masks it).

func (*ResolvedAction) Descriptor deprecated added in v0.2.0

func (*ResolvedAction) Descriptor() ([]byte, []int)

Deprecated: Use ResolvedAction.ProtoReflect.Descriptor instead.

func (*ResolvedAction) GetAuthOrigin added in v0.2.0

func (x *ResolvedAction) GetAuthOrigin() string

func (*ResolvedAction) GetError added in v0.2.0

func (x *ResolvedAction) GetError() string

func (*ResolvedAction) GetNameWithOwner added in v0.2.0

func (x *ResolvedAction) GetNameWithOwner() string

func (*ResolvedAction) GetPath added in v0.2.0

func (x *ResolvedAction) GetPath() string

func (*ResolvedAction) GetRef added in v0.2.0

func (x *ResolvedAction) GetRef() string

func (*ResolvedAction) GetResolvedSha added in v0.2.0

func (x *ResolvedAction) GetResolvedSha() string

func (*ResolvedAction) GetSource added in v0.2.0

func (x *ResolvedAction) GetSource() string

func (*ResolvedAction) GetTarballUrl added in v0.2.0

func (x *ResolvedAction) GetTarballUrl() string

func (*ResolvedAction) GetToken added in v0.2.0

func (x *ResolvedAction) GetToken() string

func (*ResolvedAction) ProtoMessage added in v0.2.0

func (*ResolvedAction) ProtoMessage()

func (*ResolvedAction) ProtoReflect added in v0.2.0

func (x *ResolvedAction) ProtoReflect() protoreflect.Message

func (*ResolvedAction) Reset added in v0.2.0

func (x *ResolvedAction) Reset()

func (*ResolvedAction) String added in v0.2.0

func (x *ResolvedAction) String() string

type Run

type Run struct {
	Script string            `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
	Env    map[string]string `` /* 133-byte string literal not displayed */
	Job    *JobSpec          `protobuf:"bytes,3,opt,name=job,proto3" json:"job,omitempty"`
	// contains filtered or unexported fields
}

Run asks the executor to run a script or a job. Without job it is the stub executor of sandbox-check: the script is run with `sh -c`; an empty script means the built-in diagnostics script. With job the executor runs the job like a GitHub Actions runner and reports it with StepStarted, Log, StepCompleted and JobResult frames, then Exit.

func (*Run) Descriptor deprecated

func (*Run) Descriptor() ([]byte, []int)

Deprecated: Use Run.ProtoReflect.Descriptor instead.

func (*Run) GetEnv

func (x *Run) GetEnv() map[string]string

func (*Run) GetJob

func (x *Run) GetJob() *JobSpec

func (*Run) GetScript

func (x *Run) GetScript() string

func (*Run) ProtoMessage

func (*Run) ProtoMessage()

func (*Run) ProtoReflect

func (x *Run) ProtoReflect() protoreflect.Message

func (*Run) Reset

func (x *Run) Reset()

func (*Run) String

func (x *Run) String() string

type StepAnnotations added in v0.2.0

type StepAnnotations struct {
	Step        int32         `protobuf:"varint,1,opt,name=step,proto3" json:"step,omitempty"`
	Annotations []*Annotation `protobuf:"bytes,2,rep,name=annotations,proto3" json:"annotations,omitempty"`
	// contains filtered or unexported fields
}

StepAnnotations is the complete list of the annotations of a step (the ones the runner keeps: at most 10 per level), replacing any earlier list of that step. Annotations of the steps inside a composite action are those of the step of the workflow that uses it.

func (*StepAnnotations) Descriptor deprecated added in v0.2.0

func (*StepAnnotations) Descriptor() ([]byte, []int)

Deprecated: Use StepAnnotations.ProtoReflect.Descriptor instead.

func (*StepAnnotations) GetAnnotations added in v0.2.0

func (x *StepAnnotations) GetAnnotations() []*Annotation

func (*StepAnnotations) GetStep added in v0.2.0

func (x *StepAnnotations) GetStep() int32

func (*StepAnnotations) ProtoMessage added in v0.2.0

func (*StepAnnotations) ProtoMessage()

func (*StepAnnotations) ProtoReflect added in v0.2.0

func (x *StepAnnotations) ProtoReflect() protoreflect.Message

func (*StepAnnotations) Reset added in v0.2.0

func (x *StepAnnotations) Reset()

func (*StepAnnotations) String added in v0.2.0

func (x *StepAnnotations) String() string

type StepCompleted

type StepCompleted struct {
	Number     int32          `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
	Name       string         `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Conclusion StepConclusion `protobuf:"varint,3,opt,name=conclusion,proto3,enum=ermite.runner.exec.v1.StepConclusion" json:"conclusion,omitempty"`
	UnixNano   int64          `protobuf:"varint,4,opt,name=unix_nano,json=unixNano,proto3" json:"unix_nano,omitempty"`
	// outcome is steps.<id>.outcome: the result before continue-on-error. It
	// differs from conclusion only for a failed step with continue-on-error.
	// UNSPECIFIED means the same as conclusion.
	Outcome StepConclusion `protobuf:"varint,5,opt,name=outcome,proto3,enum=ermite.runner.exec.v1.StepConclusion" json:"outcome,omitempty"`
	// contains filtered or unexported fields
}

func (*StepCompleted) Descriptor deprecated

func (*StepCompleted) Descriptor() ([]byte, []int)

Deprecated: Use StepCompleted.ProtoReflect.Descriptor instead.

func (*StepCompleted) GetConclusion

func (x *StepCompleted) GetConclusion() StepConclusion

func (*StepCompleted) GetName

func (x *StepCompleted) GetName() string

func (*StepCompleted) GetNumber

func (x *StepCompleted) GetNumber() int32

func (*StepCompleted) GetOutcome added in v0.2.0

func (x *StepCompleted) GetOutcome() StepConclusion

func (*StepCompleted) GetUnixNano

func (x *StepCompleted) GetUnixNano() int64

func (*StepCompleted) ProtoMessage

func (*StepCompleted) ProtoMessage()

func (*StepCompleted) ProtoReflect

func (x *StepCompleted) ProtoReflect() protoreflect.Message

func (*StepCompleted) Reset

func (x *StepCompleted) Reset()

func (*StepCompleted) String

func (x *StepCompleted) String() string

type StepConclusion

type StepConclusion int32
const (
	StepConclusion_STEP_CONCLUSION_UNSPECIFIED StepConclusion = 0
	StepConclusion_STEP_CONCLUSION_SUCCESS     StepConclusion = 1
	StepConclusion_STEP_CONCLUSION_FAILURE     StepConclusion = 2
	StepConclusion_STEP_CONCLUSION_CANCELLED   StepConclusion = 3
	StepConclusion_STEP_CONCLUSION_SKIPPED     StepConclusion = 4
	StepConclusion_STEP_CONCLUSION_TIMED_OUT   StepConclusion = 5 // jobs only
)

func (StepConclusion) Descriptor

func (StepConclusion) Enum

func (x StepConclusion) Enum() *StepConclusion

func (StepConclusion) EnumDescriptor deprecated

func (StepConclusion) EnumDescriptor() ([]byte, []int)

Deprecated: Use StepConclusion.Descriptor instead.

func (StepConclusion) Number

func (StepConclusion) String

func (x StepConclusion) String() string

func (StepConclusion) Type

type StepStarted

type StepStarted struct {
	Number   int32  `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"`
	Name     string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	UnixNano int64  `protobuf:"varint,3,opt,name=unix_nano,json=unixNano,proto3" json:"unix_nano,omitempty"`
	// contains filtered or unexported fields
}

Steps are numbered like GitHub's log: "Set up job" is 1, the steps of the workflow follow, "Complete job" is last.

func (*StepStarted) Descriptor deprecated

func (*StepStarted) Descriptor() ([]byte, []int)

Deprecated: Use StepStarted.ProtoReflect.Descriptor instead.

func (*StepStarted) GetName

func (x *StepStarted) GetName() string

func (*StepStarted) GetNumber

func (x *StepStarted) GetNumber() int32

func (*StepStarted) GetUnixNano

func (x *StepStarted) GetUnixNano() int64

func (*StepStarted) ProtoMessage

func (*StepStarted) ProtoMessage()

func (*StepStarted) ProtoReflect

func (x *StepStarted) ProtoReflect() protoreflect.Message

func (*StepStarted) Reset

func (x *StepStarted) Reset()

func (*StepStarted) String

func (x *StepStarted) String() string

type StepSummary added in v0.2.0

type StepSummary struct {
	Step     int32  `protobuf:"varint,1,opt,name=step,proto3" json:"step,omitempty"`
	Markdown string `protobuf:"bytes,2,opt,name=markdown,proto3" json:"markdown,omitempty"`
	// contains filtered or unexported fields
}

StepSummary is the masked content of GITHUB_STEP_SUMMARY after a step, at most 1 MiB.

func (*StepSummary) Descriptor deprecated added in v0.2.0

func (*StepSummary) Descriptor() ([]byte, []int)

Deprecated: Use StepSummary.ProtoReflect.Descriptor instead.

func (*StepSummary) GetMarkdown added in v0.2.0

func (x *StepSummary) GetMarkdown() string

func (*StepSummary) GetStep added in v0.2.0

func (x *StepSummary) GetStep() int32

func (*StepSummary) ProtoMessage added in v0.2.0

func (*StepSummary) ProtoMessage()

func (*StepSummary) ProtoReflect added in v0.2.0

func (x *StepSummary) ProtoReflect() protoreflect.Message

func (*StepSummary) Reset added in v0.2.0

func (x *StepSummary) Reset()

func (*StepSummary) String added in v0.2.0

func (x *StepSummary) String() string

type StreamKind

type StreamKind int32
const (
	StreamKind_STREAM_KIND_UNSPECIFIED StreamKind = 0
	StreamKind_STREAM_KIND_STDOUT      StreamKind = 1
	StreamKind_STREAM_KIND_STDERR      StreamKind = 2
)

func (StreamKind) Descriptor

func (StreamKind) Descriptor() protoreflect.EnumDescriptor

func (StreamKind) Enum

func (x StreamKind) Enum() *StreamKind

func (StreamKind) EnumDescriptor deprecated

func (StreamKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamKind.Descriptor instead.

func (StreamKind) Number

func (x StreamKind) Number() protoreflect.EnumNumber

func (StreamKind) String

func (x StreamKind) String() string

func (StreamKind) Type

type TokenPermissions added in v0.3.0

type TokenPermissions struct {
	Levels map[string]string `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

TokenPermissions maps a permission key ("contents", "pull-requests", ...) to "read", "write" or "none"; a key that is absent is none.

func (*TokenPermissions) Descriptor deprecated added in v0.3.0

func (*TokenPermissions) Descriptor() ([]byte, []int)

Deprecated: Use TokenPermissions.ProtoReflect.Descriptor instead.

func (*TokenPermissions) GetLevels added in v0.3.0

func (x *TokenPermissions) GetLevels() map[string]string

func (*TokenPermissions) ProtoMessage added in v0.3.0

func (*TokenPermissions) ProtoMessage()

func (*TokenPermissions) ProtoReflect added in v0.3.0

func (x *TokenPermissions) ProtoReflect() protoreflect.Message

func (*TokenPermissions) Reset added in v0.3.0

func (x *TokenPermissions) Reset()

func (*TokenPermissions) String added in v0.3.0

func (x *TokenPermissions) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL