branch

Documentation

Index

• type Gitlab
  • func New(spec interface{}) (*Gitlab, error)
  • func (g *Gitlab) Changelog(from, to string) *result.Changelogs
  • func (g *Gitlab) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
  • func (g *Gitlab) ReportConfig() interface{}
  • func (g *Gitlab) SearchBranches() (tags []string, err 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 {
	HeadBranch string
	// 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(from, to string) *result.Changelogs

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) ReportConfig

func (g *Gitlab) ReportConfig() interface{}

ReportConfiguration returns a new configuration with only the necessary fields to identify the resource without any sensitive information and context specific data.

func (*Gitlab) SearchBranches

func (g *Gitlab) SearchBranches() (tags []string, err error)

Retrieve GitLab branches 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] Owner specifies repository owner
	Owner string `yaml:",omitempty" jsonschema:"required"`
	// [S][C] 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"`
	// [C] Branch specifies the branch name
	Branch string `yaml:",omitempty"`
}

Spec defines settings used to interact with GitLab release

func (Spec) Validate

func (s Spec) Validate() error