Documentation
¶
Index ¶
- type Gitea
- func (g *Gitea) Add(files []string) error
- func (g *Gitea) Checkout() error
- func (g *Gitea) Clean() error
- func (g *Gitea) Clone() (string, error)
- func (g *Gitea) Commit(message string) error
- func (g *Gitea) GetBranches() (sourceBranch, workingBranch, targetBranch string)
- func (g *Gitea) GetChangedFiles(workingDir string) ([]string, error)
- func (g *Gitea) GetDirectory() (directory string)
- func (g *Gitea) GetURL() string
- func (g *Gitea) IsRemoteBranchUpToDate() (bool, error)
- func (g *Gitea) Push() (bool, error)
- func (g *Gitea) PushBranch(branch string) error
- func (g *Gitea) PushTag(tag string) error
- func (g *Gitea) SearchTags() (tags []string, err error)
- type Spec
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Gitea ¶
type Gitea struct {
// Spec contains inputs coming from updatecli configuration
Spec Spec
// contains filtered or unexported fields
}
Gitea contains information to interact with Gitea api
func (*Gitea) GetBranches ¶ added in v0.53.0
func (*Gitea) GetChangedFiles ¶
func (*Gitea) GetDirectory ¶
GetDirectory returns the local git repository path.
func (*Gitea) IsRemoteBranchUpToDate ¶ added in v0.45.0
IsRemoteBranchUpToDate checks if the branch reference name is published on on the default remote
func (*Gitea) Push ¶
Push run `git push` to the corresponding Gitea remote branch if not already created.
func (*Gitea) PushBranch ¶ added in v0.44.0
PushBranch push branch
func (*Gitea) SearchTags ¶
SearchTags retrieve git tags from a remote gitea 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:
// The default value is based on your local temporary directory like: (on Linux)
// /tmp/updatecli/github/<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
//
// remark:
// When force is set to true, Updatecli also recreates the working branches that
// diverged from their base branch.
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:
// * 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 Gitea 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>".
// The working branch can be disabled using the "workingBranch" parameter set to false.
Branch string `yaml:",omitempty"`
// WorkingBranchPrefix defines the prefix used to create a working branch.
//
// compatible:
// * scm
//
// default:
// updatecli
//
// remark:
// A working branch is composed of three components:
// 1. WorkingBranchPrefix
// 2. Target Branch
// 3. PipelineID
//
// If WorkingBranchPrefix is set to ”, then
// the working branch will look like "<branch>_<pipelineID>".
WorkingBranchPrefix *string `yaml:",omitempty"`
// WorkingBranchSeparator defines the separator used to create a working branch.
//
// compatible:
// * scm
//
// default:
// "_"
WorkingBranchSeparator *string `yaml:",omitempty"`
// "submodules" defines if Updatecli should checkout submodules.
//
// compatible:
// * scm
//
// default: true
Submodules *bool `yaml:",omitempty"`
// "workingBranch" defines if Updatecli should use a temporary branch to work on.
// If set to `true`, Updatecli create a temporary branch to work on, based on the branch value.
//
// compatible:
// * scm
//
// default: true
WorkingBranch *bool `yaml:",omitempty"`
}
Spec defines settings used to interact with Gitea release
Click to show internal directories.
Click to hide internal directories.