git

Documentation

Overview

Package git provides a client for interacting with Git providers

Index

• type Git
  • func NewGit(token provifv1.GitCredential, opts ...Options) *Git
  • func (g *Git) Clone(ctx context.Context, url, branch string) (*git.Repository, error)
• type Options
  • func WithConfig(cfg server.GitConfig) Options

Types

type Git

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

Git is the struct that contains the GitHub REST API client It implements helper functions that a provider that uses the `git` trait can use.

func NewGit

func NewGit(token provifv1.GitCredential, opts ...Options) *Git

NewGit creates a new GitHub client

func (*Git) Clone

func (g *Git) Clone(ctx context.Context, url, branch string) (*git.Repository, error)

Clone clones a git repository

type Options

type Options func(*Git)

Options implements the "functional options" pattern for Git

func WithConfig

func WithConfig(cfg server.GitConfig) Options

WithConfig configures the Git implementation with server-side configuration options.