 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Constants
- type ConcurrencyGroup
- type Condition
- type Defaults
- type DockerMetadata
- type Entity
- type EnvironmentVariables
- type EnvironmentVariablesRef
- type EventType
- type FileLocation
- type FileReference
- type Filter
- type Job
- type JobDependency
- type Matrix
- type Metadata
- type OS
- type Parameter
- type Permission
- type Pipeline
- type Runner
- type RunnerType
- type Scans
- type Shell
- type Step
- type StepType
- type Task
- type TokenPermissions
- type Trigger
- type Triggers
- type Variable
- type VersionType
Constants ¶
      View Source
      
  
    const ( PullRequestPermission = "pull-request" PushPermission = "push" RunPipelinePermission = "run-pipeline" )
      View Source
      
  
    const ( DockerRunnerType RunnerType = "docker" VmRunnerType RunnerType = "vm" ServerRunnerType RunnerType = "server" WindowsOS OS = "windows" LinuxOS OS = "linux" MacOS OS = "macos" )
      View Source
      
  
const ( CommitSHA VersionType = "commit" TagVersion VersionType = "tag" BranchVersion VersionType = "branch" Latest VersionType = "latest" None VersionType = "none" ShellStepType StepType = "shell" TaskStepType StepType = "task" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConcurrencyGroup ¶
type ConcurrencyGroup string
type Condition ¶
type Condition struct {
	Statement string            `json:"statement,omitempty"`
	Allow     *bool             `json:"allow,omitempty"`
	Paths     *Filter           `json:"paths,omitempty"`
	Exists    *Filter           `json:"exists,omitempty"`
	Branches  *Filter           `json:"branches,omitempty"`
	Events    []EventType       `json:"events,omitempty"`
	Variables map[string]string `json:"variables,omitempty"`
}
    type Defaults ¶
type Defaults struct {
	EnvironmentVariables *EnvironmentVariablesRef `json:"environment_variables,omitempty"`
	Scans                *Scans                   `json:"scans,omitempty"`
	Runner               *Runner                  `json:"runner,omitempty"`
	Conditions           []*Condition             `json:"conditions,omitempty"`
	ContinueOnError      *bool                    `json:"continue_on_error,omitempty"`
	TokenPermissions     *TokenPermissions        `json:"token_permissions,omitempty"`
	Settings             *map[string]any          `json:"settings,omitempty"`
	FileReference        *FileReference           `json:"file_reference,omitempty"`
	PostSteps            []*Step                  `json:"post_steps,omitempty"`
	PreSteps             []*Step                  `json:"pre_steps,omitempty"`
}
    type DockerMetadata ¶
type EnvironmentVariables ¶
type EnvironmentVariablesRef ¶
type EnvironmentVariablesRef struct {
	EnvironmentVariables `json:"environment_variables,omitempty"`
	FileReference        *FileReference `json:"file_reference,omitempty"`
}
    type FileLocation ¶
type FileReference ¶
type FileReference struct {
	StartRef *FileLocation `json:"start_ref,omitempty"`
	EndRef   *FileLocation `json:"end_ref,omitempty"`
	IsAlias  bool          `json:"is_alias,omitempty"`
}
    type Job ¶
type Job struct {
	ID                   *string                  `json:"id,omitempty"`
	Name                 *string                  `json:"name,omitempty"`
	Steps                []*Step                  `json:"steps,omitempty"`
	ContinueOnError      *string                  `json:"continue_on_error,omitempty"`
	PreSteps             []*Step                  `json:"pre_steps,omitempty"`
	PostSteps            []*Step                  `json:"post_steps,omitempty"`
	EnvironmentVariables *EnvironmentVariablesRef `json:"environment_variables,omitempty"`
	Runner               *Runner                  `json:"runner,omitempty"`
	Conditions           []*Condition             `json:"conditions,omitempty"`
	ConcurrencyGroup     *ConcurrencyGroup        `json:"concurrency_group,omitempty"`
	Inputs               []*Parameter             `json:"inputs,omitempty"`
	TimeoutMS            *int                     `json:"timeout_ms,omitempty"`
	Tags                 []string                 `json:"tags,omitempty"`
	TokenPermissions     *TokenPermissions        `json:"token_permissions,omitempty"`
	Dependencies         []*JobDependency         `json:"dependencies,omitempty"`
	Metadata             Metadata                 `json:"metadata,omitempty"`
	Matrix               *Matrix                  `json:"matrix,omitempty"`
	FileReference        *FileReference           `json:"file_reference,omitempty"`
}
    type JobDependency ¶
type JobDependency struct {
	JobID            *string           `json:"job_id,omitempty"`
	ConcurrencyGroup *ConcurrencyGroup `json:"concurrency_group,omitempty"`
	Pipeline         *string           `json:"pipeline,omitempty"`
}
    type Permission ¶
type Pipeline ¶
type Pipeline struct {
	Id         *string      `json:"id,omitempty"`
	Name       *string      `json:"name,omitempty"`
	Triggers   *Triggers    `json:"triggers,omitempty"`
	Jobs       []*Job       `json:"jobs,omitempty"`
	Imports    []string     `json:"imports,omitempty"`
	Parameters []*Parameter `json:"parameters,omitempty"`
	Defaults   *Defaults    `json:"defaults,omitempty"`
}
    type Runner ¶
type Runner struct {
	Type           *string         `json:"type,omitempty"`
	Labels         *[]string       `json:"labels,omitempty"`
	OS             *string         `json:"os,omitempty"`
	Arch           *string         `json:"arch,omitempty"`
	SelfHosted     *bool           `json:"self_hosted,omitempty"`
	DockerMetadata *DockerMetadata `json:"docker_metadata,omitempty"`
	FileReference  *FileReference  `json:"file_reference,omitempty"`
}
    type RunnerType ¶
type RunnerType string
type Shell ¶
type Shell struct {
	Type          *string        `json:"type,omitempty"`
	Script        *string        `json:"script,omitempty"`
	FileReference *FileReference `json:"file_reference,omitempty"`
}
    type Step ¶
type Step struct {
	ID                   *string                  `json:"id,omitempty"`
	Name                 *string                  `json:"name,omitempty"`
	Type                 StepType                 `json:"type,omitempty"`
	FailsPipeline        *bool                    `json:"fails_pipeline,omitempty"`
	Disabled             *bool                    `json:"disabled,omitempty"`
	EnvironmentVariables *EnvironmentVariablesRef `json:"environment_variables,omitempty"`
	WorkingDirectory     *string                  `json:"working_directory,omitempty"`
	Timeout              *int                     `json:"timeout,omitempty"`
	Conditions           *[]Condition             `json:"conditions,omitempty"`
	Shell                *Shell                   `json:"shell,omitempty"`
	Task                 *Task                    `json:"task,omitempty"`
	Metadata             Metadata                 `json:"metadata,omitempty"`
	AfterScript          *Shell                   `json:"after_script,omitempty"`
	FileReference        *FileReference           `json:"file_reference,omitempty"`
}
    type Task ¶
type Task struct {
	ID          *string      `json:"id,omitempty"`
	Name        *string      `json:"name,omitempty"`
	Inputs      []*Parameter `json:"inputs,omitempty"`
	Version     *string      `json:"version,omitempty"`
	VersionType VersionType  `json:"version_type,omitempty"`
}
    type TokenPermissions ¶
type TokenPermissions struct {
	Permissions   map[string]Permission
	FileReference *FileReference
}
    type Trigger ¶
type Trigger struct {
	Branches      *Filter        `json:"branches,omitempty"`
	Paths         *Filter        `json:"paths,omitempty"`
	Tags          *Filter        `json:"tags,omitempty"`
	Exists        *Filter        `json:"exists,omitempty"`
	Parameters    []Parameter    `json:"parameters,omitempty"`
	Pipelines     []string       `json:"pipelines,omitempty"`
	Filters       map[string]any `json:"filters,omitempty"`
	Event         EventType      `json:"event,omitempty"`
	Disabled      *bool          `json:"disabled,omitempty"`
	Schedules     *[]string      `json:"schedules,omitempty"`
	FileReference *FileReference `json:"file_reference,omitempty"`
}
    type Triggers ¶
type Triggers struct {
	Triggers      []*Trigger     `json:"triggers,omitempty"`
	FileReference *FileReference `json:"file_reference,omitempty"`
}
    type VersionType ¶
type VersionType string
 Click to show internal directories. 
   Click to hide internal directories.