 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- type BaseDeploymentStrategy
- type BaseJob
- type Build
- type BuildRef
- type CIJob
- type CanaryStrategy
- type Cron
- type DependsOn
- type DeploymentEnvironment
- type DeploymentEnvironmentRef
- type DeploymentHook
- type DeploymentJob
- type DeploymentStrategy
- type EnvironmentVariablesRef
- type Extends
- type Filter
- type JobContainer
- type JobStrategy
- type JobType
- type Jobs
- type Matrix
- type MountReadOnly
- type PR
- type PRRef
- type Package
- type PackageRef
- type Parameter
- type Parameters
- type Path
- type Pipeline
- type Pool
- type Repository
- type RepositoryRef
- type Resource
- type ResourceContainer
- type ResourceContainerRef
- type ResourcePipeline
- type ResourcePipelineRef
- type Resources
- type RollingStrategy
- type Schedules
- type Stage
- type Stages
- type Step
- type StepTarget
- type Steps
- type TaskInputs
- type Template
- type TemplateJob
- type TemplateStage
- type Trigger
- type TriggerRef
- type Uses
- type Variable
- type Variables
- type Webhook
- type WebhookRef
- type Workspace
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseDeploymentStrategy ¶
type BaseDeploymentStrategy struct {
	PreDeploy        *DeploymentHook `yaml:"preDeploy,omitempty"`
	Deploy           *DeploymentHook `yaml:"deploy,omitempty"`
	RouteTraffic     *DeploymentHook `yaml:"routeTraffic,omitempty"`
	PostRouteTraffic *DeploymentHook `yaml:"postRouteTraffic,omitempty"`
	On               struct {
		Failure *DeploymentHook `yaml:"failure,omitempty"`
		Success *DeploymentHook `yaml:"success,omitempty"`
	} `yaml:"on,omitempty"`
}
    type BaseJob ¶
type BaseJob struct {
	DisplayName            string            `yaml:"displayName,omitempty"`
	DependsOn              *DependsOn        `yaml:"dependsOn,omitempty"`
	Condition              string            `yaml:"condition,omitempty"`
	ContinueOnError        bool              `yaml:"continueOnError,omitempty"`
	TimeoutInMinutes       int               `yaml:"timeoutInMinutes,omitempty"`
	CancelTimeoutInMinutes int               `yaml:"cancelTimeoutInMinutes,omitempty"`
	Variables              *Variables        `yaml:"variables,omitempty"`
	Pool                   *Pool             `yaml:"pool,omitempty"`
	Container              *JobContainer     `yaml:"container,omitempty"`
	Services               map[string]string `yaml:"services,omitempty"`
	Workspace              *Workspace        `yaml:"workspace,omitempty"`
	Uses                   *Uses             `yaml:"uses,omitempty"`
	Steps                  *Steps            `yaml:"steps,omitempty"`
	TemplateContext        map[string]any    `yaml:"templateContext,omitempty"`
}
    type Build ¶
type Build struct {
	Build      string `yaml:"build,omitempty"`
	Type       string `yaml:"type,omitempty"`
	Connection string `yaml:"connection,omitempty"`
	Source     string `yaml:"source,omitempty"`
	Version    string `yaml:"version,omitempty"`
	Branch     string `yaml:"branch,omitempty"`
	Trigger    string `yaml:"trigger,omitempty"`
}
    type BuildRef ¶
type BuildRef struct {
	Build         *Build
	FileReference *models.FileReference
}
    func (*BuildRef) UnmarshalYAML ¶
type CIJob ¶
type CIJob struct {
	Job           string       `yaml:"job,omitempty"`
	Strategy      *JobStrategy `yaml:"strategy,omitempty"`
	BaseJob       `yaml:",inline"`
	FileReference *models.FileReference
}
    type CanaryStrategy ¶
type CanaryStrategy struct {
	Increments             []string `yaml:"increments,omitempty"`
	BaseDeploymentStrategy `yaml:",inline"`
}
    type DeploymentEnvironment ¶
type DeploymentEnvironmentRef ¶
type DeploymentEnvironmentRef struct {
	DeploymentEnvironment *DeploymentEnvironment `yaml:"deploymentEnvironment,omitempty"`
	FileReference         *models.FileReference
}
    func (*DeploymentEnvironmentRef) UnmarshalYAML ¶
func (der *DeploymentEnvironmentRef) UnmarshalYAML(node *yaml.Node) error
type DeploymentHook ¶
type DeploymentJob ¶
type DeploymentJob struct {
	Deployment    string                    `yaml:"deployment,omitempty"`
	Strategy      *DeploymentStrategy       `yaml:"strategy,omitempty"`
	Environment   *DeploymentEnvironmentRef `yaml:"environment,omitempty"`
	BaseJob       `yaml:",inline"`
	FileReference *models.FileReference
}
    type DeploymentStrategy ¶
type DeploymentStrategy struct {
	RunOnce *BaseDeploymentStrategy `yaml:"runOnce,omitempty"`
	Rolling *RollingStrategy        `yaml:"rolling,omitempty"`
	Canary  *CanaryStrategy         `yaml:"canary,omitempty"`
}
    type EnvironmentVariablesRef ¶
type EnvironmentVariablesRef struct {
	models.EnvironmentVariables
	FileReference *models.FileReference
}
    func (*EnvironmentVariablesRef) UnmarshalYAML ¶
func (e *EnvironmentVariablesRef) UnmarshalYAML(node *yaml.Node) error
type Extends ¶
type Extends struct {
	Template      `yaml:"inline"`
	FileReference *models.FileReference
}
    func (*Extends) UnmarshalYAML ¶
type Filter ¶
type Filter struct {
	Include []string `yaml:"include,omitempty"`
	Exclude []string `yaml:"exclude,omitempty"`
}
    func (*Filter) UnmarshalYAML ¶
type JobContainer ¶
type JobContainer struct {
	Image           string                   `yaml:"image,omitempty"`
	Endpoint        string                   `yaml:"endpoint,omitempty"`
	Env             *EnvironmentVariablesRef `yaml:"env,omitempty"`
	MapDockerSocket bool                     `yaml:"mapDockerSocket,omitempty"`
	Options         string                   `yaml:"options,omitempty"`
	Ports           []string                 `yaml:"ports,omitempty"`
	Volumes         []string                 `yaml:"volumes,omitempty"`
	MountReadOnly   *MountReadOnly           `yaml:"mountReadOnly,omitempty"`
}
    func (*JobContainer) UnmarshalYAML ¶ added in v0.1.16
func (jc *JobContainer) UnmarshalYAML(node *yaml.Node) error
type JobStrategy ¶
type Jobs ¶
type Jobs struct {
	CIJobs         []*CIJob
	DeploymentJobs []*DeploymentJob
	TemplateJobs   []*TemplateJob
	FileReference  *models.FileReference
}
    func (*Jobs) UnmarshalYAML ¶
type MountReadOnly ¶
type PRRef ¶
type PRRef struct {
	PR            *PR `yaml:"pr,omitempty"`
	FileReference *models.FileReference
}
    func (*PRRef) UnmarshalYAML ¶
type Package ¶
type Package struct {
	Package       string `yaml:"package,omitempty"`
	Type          string `yaml:"type,omitempty"`
	Connection    string `yaml:"connection,omitempty"`
	Name          string `yaml:"name,omitempty"`
	Version       string `yaml:"version,omitempty"`
	Tag           string `yaml:"tag,omitempty"`
	Trigger       string `yaml:"trigger,omitempty"`
	FileReference *models.FileReference
}
    type PackageRef ¶
type PackageRef struct {
	Package       *Package
	FileReference *models.FileReference
}
    func (*PackageRef) UnmarshalYAML ¶
func (pr *PackageRef) UnmarshalYAML(node *yaml.Node) error
type Parameters ¶
type Parameters []Parameter
func (*Parameters) UnmarshalYAML ¶
func (p *Parameters) UnmarshalYAML(node *yaml.Node) error
type Pipeline ¶
type Pipeline struct {
	Extends         *Extends      `yaml:"extends,omitempty"`
	Jobs            *Jobs         `yaml:"jobs,omitempty"`
	Stages          *Stages       `yaml:"stages,omitempty"`
	ContinueOnError *bool         `yaml:"continueOnError,omitempty"`
	Pool            *Pool         `yaml:"pool,omitempty"`
	Container       *JobContainer `yaml:"container,omitempty"`
	Name            string        `yaml:"name,omitempty"`
	Trigger         *TriggerRef   `yaml:"trigger,omitempty"`
	Parameters      *Parameters   `yaml:"parameters,omitempty"`
	PR              *PRRef        `yaml:"pr,omitempty"`
	Schedules       *Schedules    `yaml:"schedules,omitempty"`
	Resources       *Resources    `yaml:"resources,omitempty"`
	Steps           *Steps        `yaml:"steps,omitempty"`
	Variables       *Variables    `yaml:"variables,omitempty"`
	LockBehavior    string        `yaml:"lockBehavior,omitempty"`
}
    type Pool ¶
type Pool struct {
	Name          string   `yaml:"name"`
	Demands       []string `yaml:"demands"`
	VmImage       string   `yaml:"vmImage"`
	FileReference *models.FileReference
}
    func (*Pool) UnmarshalYAML ¶
type Repository ¶
type Repository struct {
	Repository    string      `yaml:"repository,omitempty"`
	Endpoint      string      `yaml:"endpoint,omitempty"` // currently not supported for templates
	Trigger       *TriggerRef `yaml:"trigger,omitempty"`
	Name          string      `yaml:"name,omitempty"`
	Type          string      `yaml:"type,omitempty"`
	Ref           string      `yaml:"ref,omitempty"`
	FileReference *models.FileReference
}
    type RepositoryRef ¶
type RepositoryRef struct {
	Repository    *Repository
	FileReference *models.FileReference
}
    func (*RepositoryRef) UnmarshalYAML ¶
func (rr *RepositoryRef) UnmarshalYAML(node *yaml.Node) error
type Resource ¶ added in v1.3.4
type Resource struct {
	// Builds        []*BuildRef             `yaml:"builds,omitempty"`
	// Containers    []*ResourceContainerRef `yaml:"containers,omitempty"`
	// Pipelines     []*ResourcePipelineRef  `yaml:"pipelines,omitempty"`
	Repositories []*RepositoryRef `yaml:"repositories,omitempty"`
	// Webhooks      []*WebhookRef           `yaml:"webhooks,omitempty"`
	// Packages      []*PackageRef           `yaml:"packages,omitempty"`
	FileReference *models.FileReference
}
    Currently can't fully load it due to mismatch in the azure pipelines documentation
func (*Resource) UnmarshalYAML ¶ added in v1.3.4
type ResourceContainer ¶
type ResourceContainer struct {
	Container         string      `yaml:"container,omitempty"`
	Type              string      `yaml:"type,omitempty"`
	Trigger           *TriggerRef `yaml:"trigger,omitempty"`
	AzureSubscription string      `yaml:"azureSubscription,omitempty"`
	ResourceGroup     string      `yaml:"resourceGroup,omitempty"`
	Registry          string      `yaml:"registry,omitempty"`
	Repository        string      `yaml:"repository,omitempty"`
	JobContainer      `yaml:",inline"`
}
    type ResourceContainerRef ¶
type ResourceContainerRef struct {
	ResourceContainer *ResourceContainer
	FileReference     *models.FileReference
}
    func (*ResourceContainerRef) UnmarshalYAML ¶
func (rcf *ResourceContainerRef) UnmarshalYAML(node *yaml.Node) error
type ResourcePipeline ¶
type ResourcePipeline struct {
	Pipeline string      `yaml:"pipeline,omitempty"`
	Project  string      `yaml:"project,omitempty"`
	Source   string      `yaml:"source,omitempty"`
	Version  string      `yaml:"version,omitempty"`
	Branch   string      `yaml:"branch,omitempty"`
	Tags     []string    `yaml:"tags,omitempty"`
	Trigger  *TriggerRef `yaml:"trigger,omitempty"`
}
    type ResourcePipelineRef ¶
type ResourcePipelineRef struct {
	ResourcePipeline *ResourcePipeline
	FileReference    *models.FileReference
}
    func (*ResourcePipelineRef) UnmarshalYAML ¶
func (rpr *ResourcePipelineRef) UnmarshalYAML(node *yaml.Node) error
type Resources ¶
type Resources struct {
	Resources     []*Resource
	FileReference *models.FileReference
}
    func (*Resources) UnmarshalYAML ¶
type RollingStrategy ¶
type RollingStrategy struct {
	MaxParallel            string `yaml:"maxParallel,omitempty"`
	BaseDeploymentStrategy `yaml:",inline"`
}
    type Schedules ¶
type Schedules struct {
	Crons         *[]Cron `yaml:"schedules,omitempty"`
	FileReference *models.FileReference
}
    func (*Schedules) UnmarshalYAML ¶
type Stage ¶
type Stage struct {
	Stage           string         `yaml:"stage,omitempty"`
	DisplayName     string         `yaml:"displayName,omitempty"`
	Pool            *Pool          `yaml:"pool,omitempty"`
	DependsOn       *DependsOn     `yaml:"dependsOn,omitempty"`
	Condition       string         `yaml:"condition,omitempty"`
	Variables       *Variables     `yaml:"variables,omitempty"`
	Jobs            *Jobs          `yaml:"jobs,omitempty"`
	LockBehavior    string         `yaml:"lockBehavior,omitempty"`
	TemplateContext map[string]any `yaml:"templateContext,omitempty"`
	FileReference   *models.FileReference
}
    type Stages ¶
type Stages struct {
	Stages         []*Stage         `yaml:"stages,omitempty"`
	TemplateStages []*TemplateStage `yaml:"templateStages,omitempty"`
	FileReference  *models.FileReference
}
    func (*Stages) UnmarshalYAML ¶
type Step ¶
type Step struct {
	Name                    string                   `yaml:"name,omitempty"`
	Condition               string                   `yaml:"condition,omitempty"`
	ContinueOnError         *bool                    `yaml:"continueOnError,omitempty"`
	DisplayName             string                   `yaml:"displayName,omitempty"`
	Target                  *StepTarget              `yaml:"target,omitempty"`
	Enabled                 *string                  `yaml:"enabled,omitempty"`
	Env                     *EnvironmentVariablesRef `yaml:"env,omitempty"`
	TimeoutInMinutes        int                      `yaml:"timeoutInMinutes,omitempty"`
	RetryCountOnTaskFailure int                      `yaml:"retryCountOnTaskFailure,omitempty"`
	Bash                    string                   `yaml:"bash,omitempty"`
	Checkout                string                   `yaml:"checkout,omitempty"`
	Clean                   bool                     `yaml:"clean,omitempty"`
	FetchDepth              int                      `yaml:"fetchDepth,omitempty"`
	Lfs                     bool                     `yaml:"lfs,omitempty"`
	PersistCredentials      bool                     `yaml:"persistCredentials,omitempty"`
	Submodules              string                   `yaml:"submodules,omitempty"`
	Path                    string                   `yaml:"path,omitempty"`
	Download                string                   `yaml:"download,omitempty"`
	DownloadBuild           string                   `yaml:"downloadBuild,omitempty"`
	Artifact                string                   `yaml:"artifact,omitempty"`
	Patterns                string                   `yaml:"patterns,omitempty"`
	GetPackage              string                   `yaml:"getPackage,omitempty"`
	Powershell              string                   `yaml:"powershell,omitempty"`
	ErrorActionPreference   string                   `yaml:"errorActionPreference,omitempty"`
	FailOnStderr            bool                     `yaml:"failOnStderr,omitempty"`
	IgnoreLASTEXITCODE      bool                     `yaml:"ignoreLASTEXITCODE,omitempty"`
	WorkingDirectory        string                   `yaml:"workingDirectory,omitempty"`
	Publish                 string                   `yaml:"publish,omitempty"`
	Pwsh                    string                   `yaml:"pwsh,omitempty"`
	RestoreCache            string                   `yaml:"restoreCache,omitempty"`
	ReviewApp               string                   `yaml:"reviewApp,omitempty"`
	SaveCache               string                   `yaml:"saveCache,omitempty"`
	Script                  string                   `yaml:"script,omitempty"`
	Task                    string                   `yaml:"task,omitempty"`
	Inputs                  *TaskInputs              `yaml:"inputs,omitempty"`
	Template                `yaml:",inline"`
	FileReference *models.FileReference
}
    type StepTarget ¶
type StepTarget struct {
	Container         string   `yaml:"container,omitempty"`
	Commands          string   `yaml:"commands,omitempty"`
	SettableVariables []string `yaml:"settableVariables,omitempty"`
	FileReference     *models.FileReference
}
    func (*StepTarget) UnmarshalYAML ¶
func (t *StepTarget) UnmarshalYAML(node *yaml.Node) error
type TaskInputs ¶
type TaskInputs commonModels.Map
func (*TaskInputs) UnmarshalYAML ¶
func (t *TaskInputs) UnmarshalYAML(value *yaml.Node) error
type TemplateJob ¶
type TemplateJob struct {
	Template      `yaml:",inline"`
	FileReference *models.FileReference
}
    type TemplateStage ¶
type TemplateStage struct {
	Template      `yaml:",inline"`
	FileReference *models.FileReference
}
    type TriggerRef ¶
type TriggerRef struct {
	Trigger       *Trigger `yaml:"trigger,omitempty"`
	FileReference *models.FileReference
}
    func (*TriggerRef) UnmarshalYAML ¶
func (tr *TriggerRef) UnmarshalYAML(node *yaml.Node) error
type WebhookRef ¶
type WebhookRef struct {
	Webhook       *Webhook
	FileReference *models.FileReference
}
    func (*WebhookRef) UnmarshalYAML ¶
func (wr *WebhookRef) UnmarshalYAML(node *yaml.Node) error
 Click to show internal directories. 
   Click to hide internal directories.