Documentation
¶
Index ¶
Constants ¶
const ( DefaultOrigin = "origin" DefaultBranch = "master" DefaultPublicKeyAuthUser = "git" )
Variables ¶
var HostKeyAlgos []string
HostKeyAlgos holds the HostKey algorithms that the SSH client will advertise to the server. If empty, Go's default is used instead.
var KexAlgos []string
KexAlgos hosts the key exchange algorithms to be used for SSH connections. If empty, Go's default is used instead.
Functions ¶
func IsConcreteCommit ¶ added in v0.25.0
IsConcreteCommit returns if a given commit is a concrete commit. Concrete commits have most of commit metadata and commit content. In contrast, a partial commit may only have some metadata and no commit content.
Types ¶
type AuthOptions ¶ added in v0.17.0
type AuthOptions struct {
Transport TransportType
Host string
Username string
Password string
Identity []byte
KnownHosts []byte
CAFile []byte
// TransportOptionsURL is a unique identifier for this set of authentication
// options. It's used by managed libgit2 transports to uniquely identify
// which credentials to use for a particular Git operation, and avoid misuse
// of credentials in a multi-tenant environment.
// It must be prefixed with a valid transport protocol ("ssh:// "or "http://") because
// of the way managed transports are registered and invoked.
// It's a field of AuthOptions despite not providing any kind of authentication
// info, as it's the only way to sneak it into git.Checkout, without polluting
// it's args and keeping it generic.
TransportOptionsURL string
}
AuthOptions are the authentication options for the Transport of communication with a remote origin.
func AuthOptionsFromSecret ¶ added in v0.17.0
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 ¶ added in v0.22.0
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 ¶ added in v0.17.0
func (o AuthOptions) Validate() error
Validate the AuthOptions against the defined Transport.
type CheckoutOptions ¶ added in v0.11.0
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
// LastRevision holds the last observed revision of the local repository.
// It is used to skip clone operations when no changes were detected.
LastRevision string
}
CheckoutOptions are the options used for a Git checkout.
type CheckoutStrategy ¶
type Commit ¶ added in v0.8.0
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 ¶ added in v0.22.0
ShortMessage returns the first 50 characters of a commit subject.
type Implementation ¶ added in v0.17.0
type Implementation string
type TransportType ¶ added in v0.17.0
type TransportType string
const ( SSH TransportType = "ssh" HTTPS TransportType = "https" HTTP TransportType = "http" )