git

Documentation

Index

• Constants
• Variables
• type AuthOptions
  • func AuthOptionsFromSecret(URL string, secret *v1.Secret) (*AuthOptions, error)
  • func AuthOptionsWithoutSecret(URL string) (*AuthOptions, error)
  • func (o AuthOptions) Validate() error
• type CheckoutOptions
• type CheckoutStrategy
• type Commit
  • func (c *Commit) ShortMessage() string
  • func (c *Commit) String() string
  • func (c *Commit) Verify(keyRing ...string) (string, error)
• type Hash
  • func (h Hash) String() string
• type Implementation
• type Signature
• type TransportType

Constants

const (
	DefaultOrigin            = "origin"
	DefaultBranch            = "master"
	DefaultPublicKeyAuthUser = "git"
)

Variables

var KexAlgos []string

List of custom key exchange algorithms to be used for ssh connections.

Types

type AuthOptions

type AuthOptions struct {
	Transport  TransportType
	Host       string
	Username   string
	Password   string
	Identity   []byte
	KnownHosts []byte
	CAFile     []byte
}

AuthOptions are the authentication options for the Transport of communication with a remote origin.

func AuthOptionsFromSecret

func AuthOptionsFromSecret(URL string, secret *v1.Secret) (*AuthOptions, error)

AuthOptionsFromSecret constructs an AuthOptions object from the given Secret, and then validates the result. It returns the AuthOptions, or an error.

func AuthOptionsWithoutSecret

func AuthOptionsWithoutSecret(URL string) (*AuthOptions, error)

AuthOptionsWithoutSecret constructs a minimal AuthOptions object from the given URL and then validates the result. It returns the AuthOptions, or an error.

func (AuthOptions) Validate

func (o AuthOptions) Validate() error

Validate the AuthOptions against the defined Transport.

type CheckoutOptions

type CheckoutOptions struct {
	// Branch to checkout, can be combined with Branch with some
	// Implementations.
	Branch string

	// Tag to checkout, takes precedence over Branch.
	Tag string

	// SemVer tag expression to checkout, takes precedence over Tag.
	SemVer string `json:"semver,omitempty"`

	// Commit SHA1 to checkout, takes precedence over Tag and SemVer,
	// can be combined with Branch with some Implementations.
	Commit string

	// RecurseSubmodules defines if submodules should be checked out,
	// not supported by all Implementations.
	RecurseSubmodules bool
}

CheckoutOptions are the options used for a Git checkout.

type CheckoutStrategy

type CheckoutStrategy interface {
	Checkout(ctx context.Context, path, url string, config *AuthOptions) (*Commit, error)
}

type Commit

type Commit struct {
	// Hash is the SHA1 hash of the commit.
	Hash Hash
	// Reference is the original reference of the commit, for example:
	// 'refs/tags/foo'.
	Reference string
	// Author is the original author of the commit.
	Author Signature
	// Committer is the one performing the commit, might be different from
	// Author.
	Committer Signature
	// Signature is the PGP signature of the commit.
	Signature string
	// Encoded is the encoded commit, without any signature.
	Encoded []byte
	// Message is the commit message, contains arbitrary text.
	Message string
}

func (*Commit) ShortMessage

func (c *Commit) ShortMessage() string

ShortMessage returns the first 50 characters of a commit subject.

func (*Commit) String

func (c *Commit) String() string

String returns a string representation of the Commit, composed out the last part of the Reference element, and/or Hash. For example: 'tag-1/a0c14dc8580a23f79bc654faa79c4f62b46c2c22', for a "tag-1" tag.

func (*Commit) Verify

func (c *Commit) Verify(keyRing ...string) (string, error)

Verify the Signature of the commit with the given key rings. It returns the fingerprint of the key the signature was verified with, or an error.

type Hash

type Hash []byte

func (Hash) String

func (h Hash) String() string

String returns the SHA1 Hash as a string.

type Implementation

type Implementation string

type Signature

type Signature struct {
	Name  string
	Email string
	When  time.Time
}

type TransportType

type TransportType string

const (
	SSH   TransportType = "ssh"
	HTTPS TransportType = "https"
	HTTP  TransportType = "http"
)