githubrelease

package
v0.96.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	KeyName = "name"
	KeyHash = "hash"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type GitHubRelease

type GitHubRelease struct {
	// contains filtered or unexported fields
}

GitHubRelease defines a resource of kind "githubrelease"

func New

func New(spec interface{}) (*GitHubRelease, error)

New returns a new valid GitHubRelease object.

func (GitHubRelease) Changelog

func (gr GitHubRelease) Changelog(from, to string) *result.Changelogs

Changelog returns the content (body) of the GitHub Release

func (GitHubRelease) Condition

func (gr GitHubRelease) Condition(source string, scm scm.ScmHandler) (pass bool, message string, err error)

func (*GitHubRelease) Source

func (gr *GitHubRelease) Source(workingDir string, resultSource *result.Source) error

Source retrieves a specific version tag from GitHub Releases.

func (GitHubRelease) Target

func (ghr GitHubRelease) Target(source string, scm scm.ScmHandler, dryRun bool, resultTarget *result.Target) error

type Spec added in v0.22.3

type Spec struct {
	// [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][c] Token specifies the credential used to authenticate with
	Token string `yaml:",omitempty" jsonschema:"required"`
	// [s][c] URL specifies the default github url in case of GitHub enterprise
	URL string `yaml:",omitempty"`
	// [s][c] Username specifies the username used to authenticate with GitHub API
	Username string `yaml:",omitempty"`
	// [s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.
	VersionFilter version.Filter `yaml:",omitempty"`
	// [s][c] TypeFilter specifies the GitHub Release type to retrieve before applying the versionfilter rule
	TypeFilter github.ReleaseType `yaml:",omitempty"`
	// [c] Tag allows to check for a specific release tag, default to source output
	Tag string `yaml:",omitempty"`
	//  "key" of the tag object to retrieve.
	//
	//  Accepted values: ['name','hash'].
	//
	//  Default: 'name'
	//  Compatible:
	//    * source
	//    * condition
	Key string `yaml:",omitempty"`
}

Spec defines a specification for a "gittag" resource parsed from an updatecli manifest file

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL