scriptrun

Documentation

Overview

Copyright 2024 The PipeCD Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Register(r registerer)
• type ContextInfo
  • func NewContextInfo(d *model.Deployment) *ContextInfo
  • func (src *ContextInfo) BuildEnv() (map[string]string, error)
• type Executor
  • func (e *Executor) Execute(sig executor.StopSignal) model.StageStatus
• type RollbackExecutor
  • func (e *RollbackExecutor) Execute(sig executor.StopSignal) model.StageStatus

Functions

func Register

func Register(r registerer)

Register registers this executor factory into a given registerer.

Types

type ContextInfo

type ContextInfo struct {
	DeploymentID        string            `json:"deploymentID,omitempty"`
	ApplicationID       string            `json:"applicationID,omitempty"`
	ApplicationName     string            `json:"applicationName,omitempty"`
	TriggeredAt         int64             `json:"triggeredAt,omitempty"`
	TriggeredCommitHash string            `json:"triggeredCommitHash,omitempty"`
	RepositoryURL       string            `json:"repositoryURL,omitempty"`
	Summary             string            `json:"summary,omitempty"`
	Labels              map[string]string `json:"labels,omitempty"`
}

ContextInfo is the information that will be passed to the script run stage.

func NewContextInfo

func NewContextInfo(d *model.Deployment) *ContextInfo

NewContextInfo creates a new ContextInfo from the given deployment.

func (*ContextInfo) BuildEnv

func (src *ContextInfo) BuildEnv() (map[string]string, error)

BuildEnv builds the environment variables from the context info.

type Executor

type Executor struct {
	executor.Input
	// contains filtered or unexported fields
}

func (*Executor) Execute

func (e *Executor) Execute(sig executor.StopSignal) model.StageStatus

type RollbackExecutor

type RollbackExecutor struct {
	executor.Input
}

func (*RollbackExecutor) Execute

func (e *RollbackExecutor) Execute(sig executor.StopSignal) model.StageStatus