git

Documentation

Index

• Constants
• Variables
• func IsDisabled(ctx context.Context) bool
• func PopulateDefaultParams(ctx context.Context, params []pipelinev1.Param) (map[string]string, error)
• func ResolveAPIGit(ctx context.Context, params map[string]string, kubeclient kubernetes.Interface, ...) (framework.ResolvedResource, error)
• func ResolveAnonymousGit(ctx context.Context, params map[string]string) (framework.ResolvedResource, error)
• func ValidateParams(ctx context.Context, params []pipelinev1.Param) error
• type Resolver
  • func (r *Resolver) GetConfigName(context.Context) string
  • func (r *Resolver) GetName(_ context.Context) string
  • func (r *Resolver) GetResolutionTimeout(ctx context.Context, defaultTimeout time.Duration) time.Duration
  • func (r *Resolver) GetSelector(_ context.Context) map[string]string
  • func (r *Resolver) Initialize(ctx context.Context) error
  • func (r *Resolver) Resolve(ctx context.Context, origParams []pipelinev1.Param) (framework.ResolvedResource, error)
  • func (r *Resolver) ValidateParams(ctx context.Context, params []pipelinev1.Param) error

Constants

const (
	// DefaultTimeoutKey is the configuration field name for controlling
	// the maximum duration of a resolution request for a file from git.
	DefaultTimeoutKey = "fetch-timeout"

	// DefaultURLKey is the configuration field name for controlling
	// the git url to fetch the remote resource from.
	DefaultURLKey = "default-url"

	// DefaultRevisionKey is the configuration field name for controlling
	// the revision to fetch the remote resource from.
	DefaultRevisionKey = "default-revision"

	// DefaultOrgKey is the configuration field name for setting a default organization when using the SCM API.
	DefaultOrgKey = "default-org"

	// ServerURLKey is the config map key for the SCM provider URL
	ServerURLKey = "server-url"
	// SCMTypeKey is the config map key for the SCM provider type
	SCMTypeKey = "scm-type"
	// APISecretNameKey is the config map key for the token secret's name
	APISecretNameKey = "api-token-secret-name"
	// APISecretKeyKey is the config map key for the containing the token within the token secret
	APISecretKeyKey = "api-token-secret-key"
	// APISecretNamespaceKey is the config map key for the token secret's namespace
	APISecretNamespaceKey = "api-token-secret-namespace"
)

const (
	// UrlParam is the git repo Url when using the anonymous/full clone approach
	UrlParam string = resource.ParamURL
	// OrgParam is the organization to find the repository in when using the SCM API approach
	OrgParam = "org"
	// RepoParam is the repository to use when using the SCM API approach
	RepoParam = "repo"
	// PathParam is the pathInRepo into the git repo where a file is located. This is used with both approaches.
	PathParam string = "pathInRepo"
	// RevisionParam is the git revision that a file should be fetched from. This is used with both approaches.
	RevisionParam string = "revision"
	// TokenParam is an optional reference to a secret name for SCM API authentication
	TokenParam string = "token"
	// TokenKeyParam is an optional reference to a key in the TokenParam secret for SCM API authentication
	TokenKeyParam string = "tokenKey"
	// DefaultTokenKeyParam is the default key in the TokenParam secret for SCM API authentication
	DefaultTokenKeyParam string = "token"
	// scmTypeParam is an optional string overriding the scm-type configuration (ie: github, gitea, gitlab etc..)
	ScmTypeParam string = "scmType"
	// serverURLParam is an optional string to the server URL for the SCM API to connect to
	ServerURLParam string = "serverURL"
)

const (

	// ConfigMapName is the git resolver's config map
	ConfigMapName = "git-resolver-config"
)

Variables

var (
	// AnnotationKeyRevision is the commit hash that was fetched
	// from git
	AnnotationKeyRevision = resolution.GroupName + "/revision"

	// AnnotationKeyOrg is the org used
	AnnotationKeyOrg = resolution.GroupName + "/org"
	// AnnotationKeyRepo is the repo used
	AnnotationKeyRepo = resolution.GroupName + "/repo"
	// AnnotationKeyPath is the path used
	AnnotationKeyPath = resolution.GroupName + "/path"
	// AnnotationKeyURL is the repo URL used
	AnnotationKeyURL = resolution.GroupName + "/url"
)

Functions

func IsDisabled

func IsDisabled(ctx context.Context) bool

func PopulateDefaultParams

func PopulateDefaultParams(ctx context.Context, params []pipelinev1.Param) (map[string]string, error)

func ResolveAPIGit

func ResolveAPIGit(ctx context.Context, params map[string]string, kubeclient kubernetes.Interface, logger *zap.SugaredLogger, cache *cache.LRUExpireCache, ttl time.Duration, clientFunc func(string, string, string, ...factory.ClientOptionFunc) (*scm.Client, error)) (framework.ResolvedResource, error)

func ResolveAnonymousGit

func ResolveAnonymousGit(ctx context.Context, params map[string]string) (framework.ResolvedResource, error)

func ValidateParams

func ValidateParams(ctx context.Context, params []pipelinev1.Param) error

Types

type Resolver

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

Resolver implements a framework.Resolver that can fetch files from git.

Deprecated: Use github.com/tektoncd/pipeline/pkg/remoteresolution/resolver/git.Resolver instead.

func (*Resolver) GetConfigName

func (r *Resolver) GetConfigName(context.Context) string

GetConfigName returns the name of the git resolver's configmap.

func (*Resolver) GetName

func (r *Resolver) GetName(_ context.Context) string

GetName returns the string name that the gitresolver should be associated with.

func (*Resolver) GetResolutionTimeout

func (r *Resolver) GetResolutionTimeout(ctx context.Context, defaultTimeout time.Duration) time.Duration

GetResolutionTimeout returns a time.Duration for the amount of time a single git fetch may take. This can be configured with the fetch-timeout field in the git-resolver-config configmap.

func (*Resolver) GetSelector

func (r *Resolver) GetSelector(_ context.Context) map[string]string

GetSelector returns the labels that resource requests are required to have for the gitresolver to process them.

func (*Resolver) Initialize

func (r *Resolver) Initialize(ctx context.Context) error

Initialize performs any setup required by the gitresolver.

func (*Resolver) Resolve

func (r *Resolver) Resolve(ctx context.Context, origParams []pipelinev1.Param) (framework.ResolvedResource, error)

Resolve performs the work of fetching a file from git given a map of parameters.

func (*Resolver) ValidateParams

func (r *Resolver) ValidateParams(ctx context.Context, params []pipelinev1.Param) error

ValidateParams returns an error if the given parameter map is not valid for a resource request targeting the gitresolver.