git

Documentation

Overview

Package git provides a small set of helper functions to get information about the current repo

Index

• func GetOrigin() (string, error)
• func GetRepoRoot() (string, error)
• func GetSlug(repoURL string) (string, error)
• func GetSlugForRepo() (string, error)
• type Differ
  • func NewDiffer(from, to Ref) *Differ
  • func (d *Differ) Diff() ([]deploy.Change, error)
  • func (d *Differ) WithRunner(cmd command.Runner) *Differ
• type Ref

Functions

func GetOrigin

func GetOrigin() (string, error)

GetOrigin returns the url of the remote origin

func GetRepoRoot

func GetRepoRoot() (string, error)

GetRepoRoot provides a simple

func GetSlug

func GetSlug(repoURL string) (string, error)

GetSlug returns the repo slug

func GetSlugForRepo

func GetSlugForRepo() (string, error)

GetSlugForRepo try to get the slug for the current repo

Types

type Differ

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

Differ implements the deploy.Differ interface for git

func NewDiffer

func NewDiffer(from, to Ref) *Differ

NewDiffer returns a new git differ

func (*Differ) Diff

func (d *Differ) Diff() ([]deploy.Change, error)

Diff implements the deploy.Differ interface

func (*Differ) WithRunner

func (d *Differ) WithRunner(cmd command.Runner) *Differ

WithRunner returns a differ with the configured runner

type Ref

type Ref string

Ref is a git ref