git

Documentation

Index

• type Git
  • func New(s Spec) (*Git, error)
  • func (g *Git) Add(files []string) error
  • func (g *Git) Checkout() error
  • func (g *Git) Clean() error
  • func (g *Git) Clone() (string, error)
  • func (g *Git) Commit(message string) error
  • func (g *Git) GetChangedFiles(workingDir string) ([]string, error)
  • func (g *Git) GetDirectory() (directory string)
  • func (g *Git) Push() error
  • func (g *Git) PushTag(tag string) error
• type Spec
  • func (gs *Spec) Merge(child interface{}) error
  • func (gs *Spec) MergeFromEnv(envPrefix string)

Types

type Git

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

func New

func New(s Spec) (*Git, error)

New returns a new git object

func (*Git) Add

func (g *Git) Add(files []string) error

Add run `git add`.

func (*Git) Checkout

func (g *Git) Checkout() error

Checkout create and then uses a temporary git branch.

func (*Git) Clean

func (g *Git) Clean() error

Clean removes the current git repository from local storage.

func (*Git) Clone

func (g *Git) Clone() (string, error)

Clone run `git clone`.

func (*Git) Commit

func (g *Git) Commit(message string) error

Commit run `git commit`.

func (*Git) GetChangedFiles

func (g *Git) GetChangedFiles(workingDir string) ([]string, error)

func (*Git) GetDirectory

func (g *Git) GetDirectory() (directory string)

GetDirectory returns the working git directory.

func (*Git) Push

func (g *Git) Push() error

Push run `git push`.

func (*Git) PushTag

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

PushTag push tags

type Spec

type Spec struct {
	// URL specifies the git url
	URL string `yaml:",omitempty" jsonschema:"required"`
	// Username specifies the username for http authentication
	Username string `yaml:",omitempty"`
	// Password specifies the password for http authentication
	Password string `yaml:",omitempty"`
	// Branch specifies the git branch
	Branch string `yaml:",omitempty"`
	// User specifies the git commit author
	User string `yaml:",omitempty"`
	// Email specifies the git commit email
	Email string `yaml:",omitempty"`
	// Directory specifies the directory to use for cloning the repository
	Directory string `yaml:",omitempty"`
	// Force is used during the git push phase to run `git push --force`.
	Force bool `yaml:",omitempty"`
	// CommitMessage contains conventional commit metadata as type or scope, used to generate the final commit message.
	CommitMessage commit.Commit `yaml:",omitempty"`
	// GPG key and passphrased used for commit signing
	GPG sign.GPGSpec `yaml:",omitempty"`
}

Spec contains settings to manipulate a git repository.

func (*Spec) Merge

func (gs *Spec) Merge(child interface{}) error

Merge returns nil if it successfully merges the child Spec into target receiver. Please note that child attributes always overrides receiver's

func (*Spec) MergeFromEnv

func (gs *Spec) MergeFromEnv(envPrefix string)

MergeFromEnv updates the target receiver with the "non zero-ed" environment variables