Documentation
¶
Overview ¶
Package deployerrors holds the typed CompositeError implementations produced by the installs deploy orchestration itself (as opposed to a runner job's tool output, which is parsed under runners/errparse). It lives next to the installs domain that consumes it: each domain owns the custom errors it knows how to produce.
Index ¶
- Constants
- func IsDeployPlanRenderFailed(err error) bool
- func NewDeployPlanRenderFailed(err error, msg string) error
- func PlanRenderDetail(err error) string
- func PlanRenderStage(err error) string
- type ComponentBuildUnavailableError
- type ComponentBuildUnavailableReason
- type DeployPlanRenderError
- func (e *DeployPlanRenderError) Error() string
- func (e *DeployPlanRenderError) Hints() compositeerrors.Hints
- func (e *DeployPlanRenderError) Sections() []compositeerrors.Section
- func (e *DeployPlanRenderError) Severity() compositeerrors.Severity
- func (e *DeployPlanRenderError) Type() compositeerrors.Type
Constants ¶
ComponentBuildUnavailableErrorType is the discriminator for a deploy that cannot proceed because the component it targets has no deployable build.
const DeployPlanRenderErrorType compositeerrors.Type = "deploy.plan_render_failed"
const DeployPlanRenderFailedTemporalType = "deploy_plan_render_failed"
Variables ¶
This section is empty.
Functions ¶
func IsDeployPlanRenderFailed ¶ added in v0.19.1197
func NewDeployPlanRenderFailed ¶ added in v0.19.1197
func PlanRenderDetail ¶ added in v0.19.1197
func PlanRenderStage ¶ added in v0.19.1197
Types ¶
type ComponentBuildUnavailableError ¶ added in v0.19.1014
type ComponentBuildUnavailableError struct {
}
ComponentBuildUnavailableError is the typed payload for a deploy that cannot run because its component build is unavailable. It implements compositeerrors.CompositeError so it can be frozen onto the owning deploy row and rendered in the dashboard, guiding the user to (re)build the component.
func (*ComponentBuildUnavailableError) Error ¶ added in v0.19.1014
func (e *ComponentBuildUnavailableError) Error() string
func (*ComponentBuildUnavailableError) Sections ¶ added in v0.19.1014
func (e *ComponentBuildUnavailableError) Sections() []compositeerrors.Section
func (*ComponentBuildUnavailableError) Severity ¶ added in v0.19.1014
func (e *ComponentBuildUnavailableError) Severity() compositeerrors.Severity
func (*ComponentBuildUnavailableError) Type ¶ added in v0.19.1014
func (e *ComponentBuildUnavailableError) Type() compositeerrors.Type
type ComponentBuildUnavailableReason ¶ added in v0.19.1014
type ComponentBuildUnavailableReason string
ComponentBuildUnavailableReason describes why the build could not be deployed.
const ( // component is in a terminal failure state (error / policy_failed). ComponentBuildUnavailableReasonFailed ComponentBuildUnavailableReason = "failed" // component yet, so there is no artifact to deploy. ComponentBuildUnavailableReasonMissing ComponentBuildUnavailableReason = "missing" )
type DeployPlanRenderError ¶ added in v0.19.1197
type DeployPlanRenderError struct {
ComponentName string `json:"component_name,omitempty"`
Stage string `json:"stage,omitempty"`
Detail string `json:"detail,omitempty"`
}
func (*DeployPlanRenderError) Error ¶ added in v0.19.1197
func (e *DeployPlanRenderError) Error() string
func (*DeployPlanRenderError) Hints ¶ added in v0.19.1197
func (e *DeployPlanRenderError) Hints() compositeerrors.Hints
func (*DeployPlanRenderError) Sections ¶ added in v0.19.1197
func (e *DeployPlanRenderError) Sections() []compositeerrors.Section
func (*DeployPlanRenderError) Severity ¶ added in v0.19.1197
func (e *DeployPlanRenderError) Severity() compositeerrors.Severity
func (*DeployPlanRenderError) Type ¶ added in v0.19.1197
func (e *DeployPlanRenderError) Type() compositeerrors.Type