git

Documentation

Overview

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Package git contains functions for interacting with git repositories.

Index

• type Git
  • func New(server types.GitServerInfo) *Git
  • func NewWithSpinner(server types.GitServerInfo, spinner *message.Spinner) *Git
  • func (g *Git) CheckoutTag(tag string) error
  • func (g *Git) CreateReadOnlyUser() error
  • func (g *Git) DoHTTPThings(request *netHttp.Request, username, secret string) ([]byte, error)
  • func (g *Git) DownloadRepoToTemp(gitURL string) error
  • func (g *Git) MutateGitURLsInText(text string) string
  • func (g *Git) Pull(gitURL, targetFolder string) error
  • func (g *Git) PushRepo(srcUrl, targetFolder string) error
  • func (g *Git) TransformURL(url string) (string, error)
  • func (g *Git) TransformURLtoRepoName(url string) (string, error)

Types

type Git

type Git struct {
	// Server is the git server configuration.
	Server types.GitServerInfo
	// Spinner is an optional spinner to use for long running operations.
	Spinner *message.Spinner
	// Target working directory for the git repository.
	GitPath string
}

Git is the main struct for managing git repositories.

func New

func New(server types.GitServerInfo) *Git

New creates a new git instance with the provided server config.

func NewWithSpinner

func NewWithSpinner(server types.GitServerInfo, spinner *message.Spinner) *Git

NewWithSpinner creates a new git instance with the provided server config and spinner.

func (*Git) CheckoutTag

func (g *Git) CheckoutTag(tag string) error

CheckoutTag performs a `git checkout` of the provided tag to a detached HEAD.

func (*Git) CreateReadOnlyUser

func (g *Git) CreateReadOnlyUser() error

CreateReadOnlyUser uses the Gitea API to create a non-admin Zarf user.

func (*Git) DoHTTPThings

func (g *Git) DoHTTPThings(request *netHttp.Request, username, secret string) ([]byte, error)

DoHTTPThings adds http request boilerplate and perform the request, checking for a successful response.

func (*Git) DownloadRepoToTemp

func (g *Git) DownloadRepoToTemp(gitURL string) error

DownloadRepoToTemp clones or updates a repo into a temp folder to perform ephemeral actions (i.e. process chart repos).

func (*Git) MutateGitURLsInText

func (g *Git) MutateGitURLsInText(text string) string

MutateGitURLsInText changes the gitURL hostname to use the repository Zarf is configured to use.

func (*Git) Pull

func (g *Git) Pull(gitURL, targetFolder string) error

Pull clones or updates a git repository into the target folder.

func (*Git) PushRepo

func (g *Git) PushRepo(srcUrl, targetFolder string) error

PushRepo pushes a git repository from the local path to the configured git server.

func (*Git) TransformURL

func (g *Git) TransformURL(url string) (string, error)

TransformURL takes a git url and returns a Zarf-compatible url.

func (*Git) TransformURLtoRepoName

func (g *Git) TransformURLtoRepoName(url string) (string, error)

TransformURLtoRepoName takes a git url and returns a Zarf-compatible repo name.