dx

Documentation

Index

• type Artifact
  • func (a *Artifact) HasCleanupPolicy() bool
  • func (a *Artifact) Vars() map[string]string
• type Chart
• type Cleanup
  • func (c *Cleanup) ResolveVars(vars map[string]string) error
• type CleanupEvent
  • func (s CleanupEvent) MarshalJSON() ([]byte, error)
  • func (s CleanupEvent) MarshalYAML() (interface{}, error)
  • func (s CleanupEvent) String() string
  • func (s *CleanupEvent) UnmarshalJSON(b []byte) error
  • func (s *CleanupEvent) UnmarshalYAML(n *yaml.Node) error
• type Deploy
• type GitEvent
  • func PRPtr() *GitEvent
  • func PushPtr() *GitEvent
  • func TagPtr() *GitEvent
  • func (s GitEvent) MarshalJSON() ([]byte, error)
  • func (s GitEvent) MarshalYAML() (interface{}, error)
  • func (s GitEvent) String() string
  • func (s *GitEvent) UnmarshalJSON(b []byte) error
  • func (s *GitEvent) UnmarshalYAML(n *yaml.Node) error
• type GitopsStatus
• type Manifest
  • func (m *Manifest) ResolveVars(vars map[string]string) error
• type Release
• type ReleaseRequest
• type ReleaseStatus
• type RollbackRequest
• type Version

Types

type Artifact

type Artifact struct {
	ID string `json:"id,omitempty"`

	Created int64 `json:"created,omitempty"`

	// The releasable version
	Version Version `json:"version,omitempty"`

	// Arbitrary environment variables from CI
	Context map[string]string `json:"context,omitempty"`

	// The complete set of Gimlet environments from the Gimlet environment files
	Environments []*Manifest `json:"environments,omitempty"`

	// CI job information, test results, Docker image information, etc
	Items []map[string]interface{} `json:"items,omitempty"`
}

Artifact that contains all metadata that can be later used for releasing and auditing

func (*Artifact) HasCleanupPolicy

func (a *Artifact) HasCleanupPolicy() bool

func (*Artifact) Vars

func (a *Artifact) Vars() map[string]string

type Chart

type Chart struct {
	Repository string `yaml:"repository" json:"repository"`
	Name       string `yaml:"name" json:"name"`
	Version    string `yaml:"version" json:"version"`
}

type Cleanup

type Cleanup struct {
	AppToCleanup string       `yaml:"app" json:"app"`
	Event        CleanupEvent `yaml:"event" json:"event"`
	Branch       string       `yaml:"branch,omitempty" json:"branch,omitempty"`
}

func (*Cleanup) ResolveVars

func (c *Cleanup) ResolveVars(vars map[string]string) error

type CleanupEvent

type CleanupEvent int

CleanupEvent represents events that cause an app instance cleanup

const (
	// BranchDeleted indicates if a git branch is deleted
	BranchDeleted CleanupEvent = iota
)

func (CleanupEvent) MarshalJSON

func (s CleanupEvent) MarshalJSON() ([]byte, error)

MarshalJSON marshals the enum as a quoted json string

func (CleanupEvent) MarshalYAML

func (s CleanupEvent) MarshalYAML() (interface{}, error)

MarshalYAML marshals the enum as a quoted yaml string

func (CleanupEvent) String

func (s CleanupEvent) String() string

func (*CleanupEvent) UnmarshalJSON

func (s *CleanupEvent) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshalls a quoted json string to the enum value

func (*CleanupEvent) UnmarshalYAML

func (s *CleanupEvent) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML unmarshalls a quoted yaml string to the enum value

type Deploy

type Deploy struct {
	Tag    string    `yaml:"tag,omitempty" json:"tag,omitempty"`
	Branch string    `yaml:"branch,omitempty" json:"branch,omitempty"`
	Event  *GitEvent `yaml:"event,omitempty" json:"event,omitempty"`
}

type GitEvent

type GitEvent int

GitEvent represents the git event that produced the artifact

const (
	// Push artifact is produced by a git push event
	Push GitEvent = iota
	// Tag artifact is produced by a git tag event
	Tag
	// PR artifact is produced by a pull request event
	PR
)

func PRPtr

func PRPtr() *GitEvent

func PushPtr

func PushPtr() *GitEvent

func TagPtr

func TagPtr() *GitEvent

func (GitEvent) MarshalJSON

func (s GitEvent) MarshalJSON() ([]byte, error)

MarshalJSON marshals the enum as a quoted json string

func (GitEvent) MarshalYAML

func (s GitEvent) MarshalYAML() (interface{}, error)

MarshalYAML marshals the enum as a quoted yaml string

func (GitEvent) String

func (s GitEvent) String() string

func (*GitEvent) UnmarshalJSON

func (s *GitEvent) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshalls a quoted json string to the enum value

func (*GitEvent) UnmarshalYAML

func (s *GitEvent) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML unmarshalls a quoted yaml string to the enum value

type GitopsStatus

type GitopsStatus struct {
	Hash       string `json:"hash,omitempty"`
	Status     string `json:"status,omitempty"`
	StatusDesc string `json:"statusDesc,omitempty"`
}

GitopsStatus holds the gitops references that were created based on an event

type Manifest

type Manifest struct {
	App       string                 `yaml:"app" json:"app"`
	Env       string                 `yaml:"env" json:"env"`
	Namespace string                 `yaml:"namespace" json:"namespace"`
	Deploy    *Deploy                `yaml:"deploy,omitempty" json:"deploy,omitempty"`
	Cleanup   *Cleanup               `yaml:"cleanup,omitempty" json:"cleanup,omitempty"`
	Chart     Chart                  `yaml:"chart" json:"chart"`
	Values    map[string]interface{} `yaml:"values" json:"values"`
}

func (*Manifest) ResolveVars

func (m *Manifest) ResolveVars(vars map[string]string) error

type Release

type Release struct {
	App string `json:"app"`
	Env string `json:"env"`

	ArtifactID  string `json:"artifactId"`
	TriggeredBy string `json:"triggeredBy"`

	Version *Version `json:"version"`

	GitopsRef  string `json:"gitopsRef"`
	GitopsRepo string `json:"gitopsRepo"`
	Created    int64  `json:"created,omitempty"`

	RolledBack bool `json:"rolledBack,omitempty"`
}

Release contains all metadata about a release event

type ReleaseRequest

type ReleaseRequest struct {
	Env         string `json:"env"`
	App         string `json:"app,omitempty"`
	ArtifactID  string `json:"artifactId"`
	TriggeredBy string `json:"triggeredBy"`
}

ReleaseRequest contains all metadata about the release intent

type ReleaseStatus

type ReleaseStatus struct {
	Status       string         `json:"status"`
	StatusDesc   string         `json:"statusDesc"`
	GitopsHashes []GitopsStatus `json:"gitopsHashes"`
}

type RollbackRequest

type RollbackRequest struct {
	Env         string `json:"env"`
	App         string `json:"app"`
	TargetSHA   string `json:"targetSHA"`
	TriggeredBy string `json:"triggeredBy"`
}

RollbackRequest contains all metadata about the rollback intent

type Version

type Version struct {
	RepositoryName string   `json:"repositoryName,omitempty"`
	SHA            string   `json:"sha,omitempty"`
	Created        int64    `json:"created,omitempty"`
	Branch         string   `json:"branch,omitempty"`
	Event          GitEvent `json:"event,omitempty"`
	SourceBranch   string   `json:"sourceBranch,omitempty"`
	TargetBranch   string   `json:"targetBranch,omitempty"`
	Tag            string   `json:"tag,omitempty"`
	AuthorName     string   `json:"authorName,omitempty"`
	AuthorEmail    string   `json:"authorEmail,omitempty"`
	CommitterName  string   `json:"committerName,omitempty"`
	CommitterEmail string   `json:"committerEmail,omitempty"`
	Message        string   `json:"message,omitempty"`
	URL            string   `json:"url,omitempty"`
}