git

Documentation

Index

• type Git
  • func NewGit(opts *Options) (*Git, error)
  • func (g *Git) Add(files ...string) error
  • func (g *Git) Clone() error
  • func (g *Git) Commit(commitMessage string) error
  • func (g *Git) Fetch() error
  • func (g *Git) GetHEADCommitHash() (string, error)
  • func (g *Git) GetRemoteHEADCommitHash() (string, error)
  • func (g *Git) GetRemoteURL() (string, error)
  • func (g *Git) PullRebase() error
  • func (g *Git) Push() error
  • func (g *Git) Status() (string, error)
• type Options
• type RepositorySyncer
  • func NewRepositorySyncerAndInit(logger logr.Logger, opts *Options, mtx *sync.Mutex) (*RepositorySyncer, error)
  • func (r *RepositorySyncer) AddFilesAndCommit(commitMessage string, files ...string) error
  • func (r *RepositorySyncer) Start(ctx context.Context) error

Types

type Git

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

func NewGit

func NewGit(opts *Options) (*Git, error)

func (*Git) Add

func (g *Git) Add(files ...string) error

func (*Git) Clone

func (g *Git) Clone() error

func (*Git) Commit

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

func (*Git) Fetch

func (g *Git) Fetch() error

func (*Git) GetHEADCommitHash

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

func (*Git) GetRemoteHEADCommitHash

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

func (*Git) GetRemoteURL

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

func (*Git) PullRebase

func (g *Git) PullRebase() error

PullRebase pulls and rebases.

func (*Git) Push

func (g *Git) Push() error

func (*Git) Status

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

type Options

type Options struct {
	// AbsLocalPath is the path of the directory to clone to.
	AbsLocalPath,

	RemoteURL,

	BranchName,

	AuthorName,

	AuthorEmail,

	GithubToken string

	// Github SSH private key file
	GithubSSHPrivkeyFilename string

	// IsEnsureEmptyDirectory ensures the local directory is empty before cloning to it.
	IsEnsureEmptyDirectory bool

	// SyncPeriod is the period in which synchronization with the git repository is guaranteed.
	SyncPeriod time.Duration

	// Whether to write certificates into the Git repository (will be false when only pushing certs to other storages)
	PushCertificates bool

	// Do not push to remote repository (but still write to the local Git clone)
	DryRun bool
}

type RepositorySyncer

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

func NewRepositorySyncerAndInit

func NewRepositorySyncerAndInit(logger logr.Logger, opts *Options, mtx *sync.Mutex) (*RepositorySyncer, error)

func (*RepositorySyncer) AddFilesAndCommit

func (r *RepositorySyncer) AddFilesAndCommit(commitMessage string, files ...string) error

func (*RepositorySyncer) Start

func (r *RepositorySyncer) Start(ctx context.Context) error