Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

deploylifecycle

package

Go to main page

Versions in this module

v0

v0.16.2

Sep 29, 2026

v0.16.1

Sep 24, 2026

v0.16.0

Sep 22, 2026

v0.15.2

Sep 16, 2026

v0.15.1

Sep 11, 2026

v0.15.0

Sep 9, 2026

Changes in this version

+ func SourceFromGitInfo(info core_v1alpha.GitInfo) core_v1alpha.Source

type BeginParams

+ AppID entity.Id

+ AuthMethod string

+ Operation Operation

+ OrganizationID string

+ ParentDeploymentID string

+ Subject string

type Locks

+ func (l *Locks) CommitActivation(ctx context.Context, appName string, appID, versionID entity.Id, ...) error

+ func (l *Locks) CommitActivationAtRevision(ctx context.Context, appName string, appID, versionID entity.Id, ...) error

+ func (l *Locks) Owns(ctx context.Context, appName, deploymentID string) (bool, error)

+ type Operation string

+ const OperationBuild

+ const OperationConfigChange

+ const OperationRedeploy

+ const OperationRollback

+ func (o Operation) Valid() bool

type Query

+ LegacyStatus Status

type Record

+ func (r *Record) AppID() entity.Id

+ func (r *Record) Canonical() bool

+ func (r *Record) CompletedAt() time.Time

+ func (r *Record) Operation() Operation

+ func (r *Record) ParentDeploymentID() string

+ func (r *Record) Phase() Phase

+ func (r *Record) StartedAt() time.Time

type Status

+ const StatusInterrupted

+ func (s Status) Canonical() Status

type Store

+ func (s *Store) AppByName(ctx context.Context, name string) (*core_v1alpha.App, int64, error)

+ func (s *Store) AppVersionByID(ctx context.Context, id string) (*core_v1alpha.AppVersion, error)

+ func (s *Store) EnsureApp(ctx context.Context, name string) (*core_v1alpha.App, int64, error)

+ func (s *Store) PublishLockOwner(ctx context.Context, dep *core_v1alpha.Deployment, ...) (*Record, error)

+ func (s *Store) ReserveLockOwner(ctx context.Context, deploymentID entity.Id) (*lockOwnerReservation, error)

+ func (s *Store) SetActivePointers(ctx context.Context, appID entity.Id, revision int64, ...) error

type Tracker

+ func (t *Tracker) ActivateAtRevision(ctx context.Context, deploymentID string, appRevision int64) error

+ func (t *Tracker) Reconcile(ctx context.Context, deploymentID string) error

v0.14.0

Aug 27, 2026

v0.13.0

Aug 4, 2026

Changes in this version

+ const DefaultLockTTL

+ var ErrLockHeld = errors.New("deployment lock held")

+ func CheckPhase(status Status, phase Phase) error

+ func LockID(appName string) entity.Id

+ func Transition(from, to Status) error

+ type BeginParams struct

+ AppName string

+ AppVersion string

+ ClusterID string

+ DeployedBy core_v1alpha.DeployedBy

+ GitInfo core_v1alpha.GitInfo

+ SourceDeploymentID string

+ type Holder struct

+ AcquiredAt time.Time

+ AppName string

+ DeploymentID string

+ ExpiresAt time.Time

+ Revision int64

+ func HolderFrom(err error) (*Holder, bool)

+ func (h *Holder) Expired(now time.Time) bool

+ type LockHeldError struct

+ Holder *Holder

+ func (e *LockHeldError) Error() string

+ func (e *LockHeldError) Is(target error) bool

+ type Locks struct

+ func NewLocks(log *slog.Logger, eac *entityserver_v1alpha.EntityAccessClient, ...) *Locks

+ func (l *Locks) Acquire(ctx context.Context, appName, deploymentID string) (*Holder, error)

+ func (l *Locks) Blocking(ctx context.Context, appName string) (*Holder, error)

+ func (l *Locks) Get(ctx context.Context, appName string) (*Holder, error)

+ func (l *Locks) Release(ctx context.Context, appName, deploymentID string) error

+ type Phase string

+ const PhaseActivating

+ const PhaseBuilding

+ const PhasePreparing

+ const PhasePushing

+ func ParsePhase(s string) (Phase, error)

+ func (p Phase) String() string

+ func (p Phase) Valid() bool

+ type Query struct

+ AppName string

+ Limit int

+ Status Status

+ type Record struct

+ Deployment *core_v1alpha.Deployment

+ Entity *entityserver_v1alpha.Entity

+ Revision int64

+ func (r *Record) AppVersion() string

+ func (r *Record) Status() Status

+ type Status string

+ const StatusActive

+ const StatusCancelled

+ const StatusFailed

+ const StatusInProgress

+ const StatusRolledBack

+ const StatusSucceeded

+ func ParseStatus(s string) (Status, error)

+ func (s Status) String() string

+ func (s Status) Terminal() bool

+ func (s Status) Valid() bool

+ type StatusLookup func(ctx context.Context, deploymentID string) (Status, error)

+ type Store struct

+ func NewStore(log *slog.Logger, eac *entityserver_v1alpha.EntityAccessClient) *Store

+ func (s *Store) Create(ctx context.Context, dep *core_v1alpha.Deployment) (*Record, error)

+ func (s *Store) Delete(ctx context.Context, deploymentID string) error

+ func (s *Store) Get(ctx context.Context, deploymentID string) (*Record, error)

+ func (s *Store) List(ctx context.Context, q Query) ([]*Record, error)

+ func (s *Store) MarkPreviousActiveAs(ctx context.Context, appName, exceptID string, target Status) error

+ func (s *Store) Put(ctx context.Context, rec *Record) error

+ func (s *Store) Status(ctx context.Context, deploymentID string) (Status, error)

+ type Tracker struct

+ func NewTracker(log *slog.Logger, eac *entityserver_v1alpha.EntityAccessClient) *Tracker

+ func (t *Tracker) Activate(ctx context.Context, deploymentID string) error

+ func (t *Tracker) ActivateRollback(ctx context.Context, deploymentID string) error

+ func (t *Tracker) Begin(ctx context.Context, params BeginParams) (*Record, error)

+ func (t *Tracker) Cancel(ctx context.Context, deploymentID, reason string) error

+ func (t *Tracker) Fail(ctx context.Context, deploymentID, errorMessage, buildLogs string) error

+ func (t *Tracker) FailIfUnsettled(ctx context.Context, deploymentID, errorMessage, buildLogs string) error

+ func (t *Tracker) Locks() *Locks

+ func (t *Tracker) ReleaseLock(ctx context.Context, deploymentID string) error

+ func (t *Tracker) SetAppVersion(ctx context.Context, deploymentID, appVersionID string) error

+ func (t *Tracker) SetPhase(ctx context.Context, deploymentID string, phase Phase) error

+ func (t *Tracker) Store() *Store