gitlab

Documentation

Index

• type Gitlab
  • func New(spec interface{}, pipelineID string) (*Gitlab, error)
  • func (g *Gitlab) Add(files []string) error
  • func (g *Gitlab) Checkout() error
  • func (g *Gitlab) Clean() error
  • func (g *Gitlab) Clone() (string, error)
  • func (g *Gitlab) Commit(message string) error
  • func (g *Gitlab) GetBranches() (sourceBranch, workingBranch, targetBranch string)
  • func (g *Gitlab) GetChangedFiles(workingDir string) ([]string, error)
  • func (g *Gitlab) GetDirectory() (directory string)
  • func (g *Gitlab) GetURL() string
  • func (g *Gitlab) IsRemoteBranchUpToDate() (bool, error)
  • func (g *Gitlab) Push() error
  • func (g *Gitlab) PushBranch(branch string) error
  • func (g *Gitlab) PushTag(tag string) error
  • func (g *Gitlab) SearchTags() (tags []string, err error)
• type Spec
  • func (s *Spec) Validate() error

Types

type Gitlab

type Gitlab struct {
	// Spec contains inputs coming from updatecli configuration
	Spec Spec
	// contains filtered or unexported fields
}

Gitlab contains information to interact with GitLab api

func New

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

New returns a new valid GitLab object.

func (*Gitlab) Add

func (g *Gitlab) Add(files []string) error

Add run `git add`.

func (*Gitlab) Checkout

func (g *Gitlab) Checkout() error

Checkout create and then uses a temporary git branch.

func (*Gitlab) Clean

func (g *Gitlab) Clean() error

Clean deletes github working directory.

func (*Gitlab) Clone

func (g *Gitlab) Clone() (string, error)

Clone run `git clone`.

func (*Gitlab) Commit

func (g *Gitlab) Commit(message string) error

Commit run `git commit`.

func (*Gitlab) GetBranches

func (g *Gitlab) GetBranches() (sourceBranch, workingBranch, targetBranch string)

GetBranches returns the source, working and target branches.

func (*Gitlab) GetChangedFiles

func (g *Gitlab) GetChangedFiles(workingDir string) ([]string, error)

GetChangedFiles returns a list of changed files

func (*Gitlab) GetDirectory

func (g *Gitlab) GetDirectory() (directory string)

GetDirectory returns the local git repository path.

func (*Gitlab) GetURL

func (g *Gitlab) GetURL() string

GetURL returns a "GitLab" git URL

func (*Gitlab) IsRemoteBranchUpToDate

func (g *Gitlab) IsRemoteBranchUpToDate() (bool, error)

IsRemoteBranchUpToDate checks if the branch reference name is published on on the default remote

func (*Gitlab) Push

func (g *Gitlab) Push() error

Push run `git push` to the corresponding GitLab remote branch if not already created.

func (*Gitlab) PushBranch

func (g *Gitlab) PushBranch(branch string) error

PushBranch push branch

func (*Gitlab) PushTag

func (g *Gitlab) PushTag(tag string) error

PushTag push tags

func (*Gitlab) SearchTags

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

SearchTags retrieves git tags from a remote gitlab repository

type Spec

type Spec struct {
	client.Spec `yaml:",inline,omitempty"`
	/*
		"commitMessage" is used to generate the final commit message.

		compatible:
			* scm

		remark:
			it's worth mentioning that the commit message settings is applied to all targets linked to the same scm.
	*/
	CommitMessage commit.Commit `yaml:",omitempty"`
	/*
		"directory" defines the local path where the git repository is cloned.

		compatible:
			* scm

		remark:
			Unless you know what you are doing, it is recommended to use the default value.
			The reason is that Updatecli may automatically clean up the directory after a pipeline execution.

		default:
			/tmp/updatecli/gitlab/<owner>/<repository>
	*/
	Directory string `yaml:",omitempty"`
	/*
		"email" defines the email used to commit changes.

		compatible:
			* scm

		default:
			default set to your global git configuration
	*/
	Email string `yaml:",omitempty"`
	/*
		"force" is used during the git push phase to run `git push --force`.

		compatible:
			* scm

		default:
			false
	*/
	Force bool `yaml:",omitempty"`
	/*
		"gpg" specifies the GPG key and passphrased used for commit signing

		compatible:
			* scm
	*/
	GPG sign.GPGSpec `yaml:",omitempty"`
	/*
		"owner" defines the owner of a repository.

		compatible:
			* scm
	*/
	Owner string `yaml:",omitempty" jsonschema:"required"`
	/*
		repository specifies the name of a repository for a specific owner.

		compatible:
			* action
			* scm
	*/
	Repository string `yaml:",omitempty" jsonschema:"required"`
	/*
		"user" specifies the user associated with new git commit messages created by Updatecli

		compatible:
			* scm
	*/
	User string `yaml:",omitempty"`
	/*
		"branch" defines the git branch to work on.

		compatible:
			* scm

		default:
			main

		remark:
			depending on which resource references the GitLab scm, the behavior will be different.

			If the scm is linked to a source or a condition (using scmid), the branch will be used to retrieve
			file(s) from that branch.

			If the scm is linked to target then Updatecli creates a new "working branch" based on the branch value.
			The working branch created by Updatecli looks like "updatecli_<pipelineID>".
			It is worth mentioning that it is not possible to bypass the working branch in the current situation.
			For more information, please refer to the following issue:
			https://github.com/updatecli/updatecli/issues/1139

			If you need to push changes to a specific branch, you must use the plugin "git" instead of this
	*/
	Branch string `yaml:",omitempty"`
}

Spec defines settings used to interact with GitLab release

func (*Spec) Validate

func (s *Spec) Validate() error