release

Documentation

Index

• type Deploy
  • func NewDeploy(c ergo.CLI, host ergo.Host, ...) *Deploy
  • func (r *Deploy) Do(ctx context.Context, releaseIntervalInput string, releaseOffsetInput string, ...) error
• type Draft
  • func NewDraft(c ergo.CLI, host ergo.Host, baseBranch, releaseBodyPrefix string, ...) *Draft
  • func (d *Draft) Create(ctx context.Context, releaseName, tagName string, skipConfirm bool) error
• type Tag
  • func NewTag(host ergo.Host) *Tag
  • func (t Tag) Create(ctx context.Context, version *ergo.Version) (*ergo.Tag, error)
  • func (t Tag) ExistsTagName(ctx context.Context, tagName string) (bool, error)
• type Version
  • func NewVersion(host ergo.Host, baseBranch string) *Version
  • func (v Version) NextVersion(ctx context.Context, inputVersion, suffix string, major, minor bool) (*ergo.Version, error)

Types

type Deploy

type Deploy struct {
	// contains filtered or unexported fields
}

Deploy is responsible to describe the release process.

func NewDeploy

func NewDeploy(
	c ergo.CLI,
	host ergo.Host,
	baseBranch, releaseBodyFind, releaseBodyReplace string,
	releaseBranches []string,
	releaseBodyBranches map[string]string,
) *Deploy

NewDeploy initialize and return a new Deploy object.

func (*Deploy) Do

func (r *Deploy) Do(
	ctx context.Context,
	releaseIntervalInput string,
	releaseOffsetInput string,
	allowForcePush bool,
	skipConfirm bool,
	publishDraft bool,
) error

Do is responsible for deploying the latest release.

type Draft

type Draft struct {
	// contains filtered or unexported fields
}

Draft is responsible for creating the draft release.

func NewDraft

func NewDraft(
	c ergo.CLI,
	host ergo.Host,
	baseBranch, releaseBodyPrefix string,
	releaseBranches []string,
	releaseBodyBranches map[string]string,
) *Draft

NewDraft initialize and return a new Draft object.

func (*Draft) Create

func (d *Draft) Create(ctx context.Context, releaseName, tagName string, skipConfirm bool) error

Create is responsible to create a new draft release.

type Tag

type Tag struct {
	// contains filtered or unexported fields
}

Tag describes the actions of tag entity.

func NewTag

func NewTag(host ergo.Host) *Tag

NewTag initialize and return a new tag object.

func (Tag) Create

func (t Tag) Create(ctx context.Context, version *ergo.Version) (*ergo.Tag, error)

Create a new tag.

func (Tag) ExistsTagName

func (t Tag) ExistsTagName(ctx context.Context, tagName string) (bool, error)

ExistsTagName checks if a tag exists by its name

type Version

type Version struct {
	// contains filtered or unexported fields
}

Version is responsible to describe the actions of visioning.

func NewVersion

func NewVersion(host ergo.Host, baseBranch string) *Version

NewVersion initializes and return a new Version object.

func (Version) NextVersion

func (v Version) NextVersion(ctx context.Context, inputVersion, suffix string, major, minor bool) (*ergo.Version, error)

NextVersion finds the next version according to major/minor/patch pattern.