release

Documentation

Index

• Constants
• Variables
• type ArtifactSum
• type Candidate
  • func (z *Candidate) Exec(c app_control.Control) error
  • func (z *Candidate) Preset()
  • func (z *Candidate) Test(c app_control.Control) error
• type Doc
  • func (z *Doc) Exec(c app_control.Control) error
  • func (z *Doc) Preset()
  • func (z *Doc) Test(c app_control.Control) error
• type Metadata
• type Notes
• type Publish
  • func (z *Publish) Exec(c app_control.Control) error
  • func (z *Publish) Preset()
  • func (z *Publish) Test(c app_control.Control) error

Constants

const (
	MinimumSpecDocVersion = 59
)

Variables

var (
	ErrorBuildIsNotReadyForRelease = errors.New("the build does not satisfy release criteria")
	ErrorNoArtifactFound           = errors.New("no artifact found")
)

Types

type ArtifactSum

type ArtifactSum struct {
	Filename string
	Size     int64
	MD5      string
	SHA256   string
}

type Candidate

type Candidate struct {
	rc_recipe.RemarkConsole
	rc_recipe.RemarkSecret
	Auth      *auth.Connect
	Recipe    *test.Recipe
	Doc       *Doc
	Preflight *build.Preflight
	License   *build.License
}

func (*Candidate) Exec

func (z *Candidate) Exec(c app_control.Control) error

func (*Candidate) Preset

func (z *Candidate) Preset()

func (*Candidate) Test

func (z *Candidate) Test(c app_control.Control) error

type Doc

type Doc struct {
	rc_recipe.RemarkSecret
	Peer gh_conn.ConnGithubPublic
}

func (*Doc) Exec

func (z *Doc) Exec(c app_control.Control) error

func (*Doc) Preset

func (z *Doc) Preset()

func (*Doc) Test

func (z *Doc) Test(c app_control.Control) error

type Metadata

type Metadata struct {
	// Release version
	Version *es_version.Version `json:"release_major"`

	// Tag name like "90.8.991"
	TagName string `json:"version_full" path:"tag_name"`

	// Release page url like "https://github.com/watermint/toolbox/releases/tag/90.8.991"
	ReleasePage string `json:"release_page" path:"html_url"`

	// Release name like "Release 90.8.991"
	ReleaseName string `json:"release_name" path:"name"`

	// Publish date like "2021-04-30T07:24:33Z"
	PublishedAt string `json:"published_at" path:"published_at"`

	// Draft flag
	Draft bool `json:"draft" path:"draft"`

	// Pre release flag
	PreRelease bool `json:"pre_release" path:"prerelease"`

	// Release notes
	ReleaseNotes string `json:"release_notes" path:"body"`
}

type Notes

type Notes struct {
	Version *es_version.Version `json:"version"`
	Date    time.Time           `json:"date"`
	Notes   string              `json:"notes"`
	Url     string              `json:"url"`
}

type Publish

type Publish struct {
	rc_recipe.RemarkConsole
	rc_recipe.RemarkSecret
	ArtifactPath mo_path2.FileSystemPath
	Branch       string
	ConnGithub   gh_conn.ConnGithubRepo
	SkipTests    bool
	Recipe       *test.Recipe
	Formula      *homebrew.Formula

	HeadingReleaseTheme       app_msg.Message
	HeadingChanges            app_msg.Message
	ListSpecChange            app_msg.Message
	HeadingDocument           app_msg.Message
	ListReadme                app_msg.Message
	HeadingBinary             app_msg.Message
	BinaryTableHeaderFilename app_msg.Message
	BinaryTableHeaderSize     app_msg.Message
	BinaryTableHeaderMD5      app_msg.Message
	BinaryTableHeaderSHA256   app_msg.Message
	TagCommitMessage          app_msg.Message
	ReleaseName               app_msg.Message
	ReleaseNameBeta           app_msg.Message
	ReleaseNameDev            app_msg.Message
}

func (*Publish) Exec

func (z *Publish) Exec(c app_control.Control) error

func (*Publish) Preset

func (z *Publish) Preset()

func (*Publish) Test

func (z *Publish) Test(c app_control.Control) error