git

Documentation

Overview

Package git makes a git repository out of a local directory, keeps the content committed when the directory content changes, and optionaly (if a remote repos url is provided), keep it in sync with a remote repository.

It requires the git command in $PATH, since the pure Go git implementations aren't up to the task (see go-git issues #793 and #785 for instance).

Index

• Variables
• type Store
  • func New(log logger, dryRun bool, dir, url string) *Store
  • func (s *Store) CloneOrInit() (err error)
  • func (s *Store) Commit() (changed bool, err error)
  • func (s *Store) Git(args ...string) error
  • func (s *Store) Push() error
  • func (s *Store) Start() (*Store, error)
  • func (s *Store) Status() (changed bool, err error)
  • func (s *Store) Stop()

Variables

var (
	// TimeoutCommands defines the max execution time for git commands
	TimeoutCommands = 60 * time.Second

	// CheckInterval defines the interval between local directory checks
	CheckInterval = 10 * time.Second

	// GitAuthor is the name of the commiter
	GitAuthor = "Katafygio"

	// GitEmail is the email of the commiter
	GitEmail = "katafygio@localhost"

	// GitMsg is the commit message we'll use
	GitMsg = "Kubernetes cluster change"
)

Types

type Store

type Store struct {
	Logger   logger
	LocalDir string
	URL      string
	Author   string
	Email    string
	Msg      string
	DryRun   bool
	// contains filtered or unexported fields
}

Store will maintain a git repository off dumped kube objects

func New

func New(log logger, dryRun bool, dir, url string) *Store

New instantiate a new git Store. url is optional.

func (*Store) CloneOrInit

func (s *Store) CloneOrInit() (err error)

CloneOrInit create a new local repository, either with "git clone" (if a GitURL to clone from is provided), or "git init" (in the absence of GitURL).

func (*Store) Commit

func (s *Store) Commit() (changed bool, err error)

Commit git commit all the directory's changes

func (*Store) Git

func (s *Store) Git(args ...string) error

Git wraps the git command

func (*Store) Push

func (s *Store) Push() error

Push git push to the origin

func (*Store) Start

func (s *Store) Start() (*Store, error)

Start maintains a directory content committed

func (*Store) Status

func (s *Store) Status() (changed bool, err error)

Status tests the git status of a repository

func (*Store) Stop

func (s *Store) Stop()

Stop stops the git goroutine