release

Documentation

Index

• type Gitlab
  • func New(spec interface{}) (*Gitlab, error)
  • func (g *Gitlab) Changelog() string
  • func (g *Gitlab) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
  • func (g *Gitlab) SearchReleases() ([]string, error)
  • func (g *Gitlab) Source(workingDir string, resultSource *result.Source) error
  • func (g Gitlab) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error
• type Spec
  • func (s Spec) Validate() error

Types

type Gitlab

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

Gitlab contains information to interact with GitLab api

func New

func New(spec interface{}) (*Gitlab, error)

New returns a new valid GitLab object.

func (*Gitlab) Changelog

func (g *Gitlab) Changelog() string

Changelog returns the changelog for this resource, or an empty string if not supported

func (*Gitlab) Condition

func (g *Gitlab) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)

func (*Gitlab) SearchReleases

func (g *Gitlab) SearchReleases() ([]string, error)

Retrieve git tags from a remote GitLab repository

func (*Gitlab) Source

func (g *Gitlab) Source(workingDir string, resultSource *result.Source) error

func (Gitlab) Target

func (g Gitlab) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error

Target ensure that a specific release exist on GitLab, otherwise creates it

type Spec

type Spec struct {
	client.Spec `yaml:",inline,omitempty"`
	// [S][C][T] Owner specifies repository owner
	Owner string `yaml:",omitempty" jsonschema:"required"`
	// [S][C][T]Repository specifies the name of a repository for a specific owner
	Repository string `yaml:",omitempty" jsonschema:"required"`
	// [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	VersionFilter version.Filter `yaml:",omitempty"`
	// [T] Title defines the GitLab release title.
	Title string `yaml:",omitempty"`
	// [C][T] Tag defines the GitLab release tag.
	Tag string `yaml:",omitempty"`
	// [T] Commitish defines the commit-ish such as `main`
	Commitish string `yaml:",omitempty"`
	// [T] Description defines if the new release description
	Description string `yaml:",omitempty"`
	// [T] Draft defines if the release is a draft release
	Draft bool `yaml:",omitempty"`
	// [T] Prerelease defines if the release is a pre-release release
	Prerelease bool `yaml:",omitempty"`
}

Spec defines settings used to interact with GitLab release

func (Spec) Validate

func (s Spec) Validate() error