Documentation
¶
Index ¶
- type GitTag
- func (gt *GitTag) Changelog(from, to string) *result.Changelogs
- func (gt *GitTag) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
- func (gt *GitTag) Source(workingDir string, resultSource *result.Source) error
- func (gt *GitTag) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error
- func (gt *GitTag) Validate() error
- type Spec
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GitTag ¶
type GitTag struct {
// contains filtered or unexported fields
}
GitTag defines a resource of kind "gittag"
func New ¶
New returns a reference to a newly initialized GitTag object from a Spec or an error if the provided Filespec triggers a validation error.
func (*GitTag) Changelog ¶
func (gt *GitTag) Changelog(from, to string) *result.Changelogs
Changelog returns the changelog for this resource, or an empty string if not supported
func (*GitTag) Condition ¶
func (gt *GitTag) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)
Condition checks that a git tag exists
type Spec ¶
type Spec struct {
// Path contains the git repository path
Path string `yaml:",omitempty"`
// VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
//
// compatible:
// * source
// * condition
// * target
VersionFilter version.Filter `yaml:",omitempty"`
// Message associated to the git tag
//
// compatible:
// * target
Message string `yaml:",omitempty"`
// "key" of the tag object to retrieve.
//
// Accepted values: ['name','hash'].
//
// Default: 'name'
// Compatible:
// * source
Key string `yaml:",omitempty"`
// "url" specifies the git url to use for fetching Git Tags.
//
// compatible:
// * source
// * condition
// * target
//
// example:
// * git@github.com:updatecli/updatecli.git
// * https://github.com/updatecli/updatecli.git
//
// remarks:
// when using the ssh protocol, the user must have the right to clone the repository
// based on its local ssh configuration
URL string `yaml:",omitempty" jsonschema:"required"`
// "username" specifies the username when using the HTTP protocol
//
// compatible
// * source
// * condition
// * target
Username string `yaml:",omitempty"`
// "password" specifies the password when using the HTTP protocol
//
// compatible:
// * source
// * condition
// * target
Password string `yaml:",omitempty"`
// "sourcebranch" defines the branch name used as a source to create the new Git branch.
//
// compatible:
// * target
//
// remark:
// * sourcebranch is required when the scmid is not defined.
SourceBranch string `yaml:",omitempty"`
}
Spec defines a specification for a "gittag" resource parsed from an updatecli manifest file
Click to show internal directories.
Click to hide internal directories.