mergerequest

Documentation

Index

• type Gitlab
  • func New(spec interface{}, scm *gitlabscm.Gitlab) (Gitlab, error)
  • func (g *Gitlab) CleanAction(report reports.Action) error
  • func (g *Gitlab) CreateAction(report reports.Action, resetDescription bool) error
• type Spec

Types

type Gitlab

type Gitlab struct {

	// SourceBranch specifies the pullrequest source branch.
	SourceBranch string `yaml:",inline,omitempty"`
	// TargetBranch specifies the pullrequest target branch
	TargetBranch string `yaml:",inline,omitempty"`
	// Owner specifies repository owner
	Owner string `yaml:",omitempty" jsonschema:"required"`
	// Repository specifies the name of a repository for a specific owner
	Repository string `yaml:",omitempty" jsonschema:"required"`
	// contains filtered or unexported fields
}

Gitlab contains information to interact with GitLab api

func New

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

New returns a new valid GitLab object.

func (*Gitlab) CleanAction

func (g *Gitlab) CleanAction(report reports.Action) error

CleanAction verifies if existing action requires some operations

func (*Gitlab) CreateAction

func (g *Gitlab) CreateAction(report reports.Action, resetDescription bool) error

CreateAction opens a Merge Request on the GitLab server

type Spec

type Spec struct {
	client.Spec
	/*
		"sourcebranch" defines the branch name used as a source to create the GitLab mergerequest.

		default:
			"sourcebranch" inherits the value from the scm branch if a scm of kind "gitlab" is specified by the action.

		remark:
			unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.
	*/
	SourceBranch string `yaml:",omitempty"`
	/*
		"targetbranch" defines the branch name used as a target to create the GitLab mergerequest.

		default:
			"targetbranch" inherits the value from the scm working branch if a scm of kind "gitlab" is specified by the action.

		remark:
			unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.
			the GitLab scm will create and use a working branch such as updatecli_xxxx
	*/
	TargetBranch string `yaml:",omitempty"`
	/*
		"owner" defines the GitLab repository owner.

		remark:
			unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.
	*/
	Owner string `yaml:",omitempty"`
	/*
		"repository" defines the GitLab repository for a specific owner

		remark:
			unless you know what you are doing, you shouldn't set this value and rely on the scmid to provide the sane default.
	*/
	Repository string `yaml:",omitempty"`
	/*
		"title" defines the GitLab mergerequest title

		default:
			A GitLab mergerequest title is defined by one of the following location (first match)
				1. title is defined by the spec such as:

					actions:
						default:
							kind: gitlab/mergerequest
							scmid: default
							spec:
								title: This is my awesome title

				2. title is defined by the action such as:

					actions:
						default:
							kind: gitlab/mergerequest
							scmid default
							title: This is my awesome title

				3. title is defined by the first associated target title

				4. title is defined by the pipeline title

		remark:
			usually we prefer to go with option 2
	*/
	Title string `yaml:",omitempty"`
	/*
		"body" defines a custom mergerequest body

		default:
			By default a mergerequest body is generated out of a pipeline execution.

		remark:
			Unless you know what you are doing, you shouldn't set this value and rely on the sane default.
			"body" is useful to provide additional information when reviewing mergerequest, such as changelog url.
	*/
	Body string `yaml:",omitempty"`
}

Spec defines settings used to interact with GitLab pullrequest It's a mapping of user input from a Updatecli manifest and it shouldn't modified