gitops

Documentation

Index

• Constants
• Variables
• type Branch
  • func (b *Branch) GetGitMode() config.GitMode
  • func (b *Branch) IsLocal() bool
  • func (b *Branch) Short() string
  • func (b *Branch) String() string
• type CheckoutResult
  • func (r *CheckoutResult) String() string
• type CloneResult
  • func (r *CloneResult) String() string
• type Commit
• type CommitUser
  • func (u *CommitUser) String() string
• type CreateResult
  • func (r *CreateResult) String() string
• type GitService
  • func NewGitService(sh shell.Shell) GitService
  • func (g *GitService) Checkout(repo *model.Repo, ref string) (CheckoutResult, error)
  • func (g *GitService) CleanBranches(repo *model.Repo, mode config.GitMode) (string, error)
  • func (g *GitService) CloneRepo(repo *model.Repo, recreate bool) (CloneResult, error)
  • func (g *GitService) Commit(repo *model.Repo, pattern string, message string) error
  • func (g *GitService) CreateBranch(repo *model.Repo, name string) (CreateResult, error)
  • func (g *GitService) Discard(repo *model.Repo) error
  • func (g *GitService) Fetch(repo *model.Repo) error
  • func (g *GitService) GetBranches(repo *model.Repo, mode config.GitMode, pattern string) ([]Branch, error)
  • func (g *GitService) GetDefaultBranch(repo *model.Repo) (*Branch, error)
  • func (g *GitService) GetUnmergedBranches(repo *model.Repo, mode config.GitMode, ref string) ([]Branch, error)
  • func (g *GitService) GetUnmergedCommits(repo *model.Repo, branch Branch, ref string) ([]Commit, error)
  • func (g *GitService) Pull(repo *model.Repo) error
  • func (g *GitService) Push(repo *model.Repo, branch string, allBranches bool, force bool) error
  • func (g *GitService) RemoveBranch(repo *model.Repo, branch Branch) error
  • func (g *GitService) Status(repo *model.Repo) (StatusResult, string, error)
• type StatusResult
  • func (r *StatusResult) String() string

Constants

const (
	RefPrefix       = "refs/"
	RefHeadPrefix   = RefPrefix + "heads/"
	RefRemotePrefix = RefPrefix + "remotes/"
	Head            = "HEAD"
)

Variables

var (
	ErrDetachedHead = errors.New("detached head")
)

Types

type Branch

type Branch struct {
	Name   string
	Remote string
}

func (*Branch) GetGitMode

func (b *Branch) GetGitMode() config.GitMode

func (*Branch) IsLocal

func (b *Branch) IsLocal() bool

func (*Branch) Short

func (b *Branch) Short() string

func (*Branch) String

func (b *Branch) String() string

type CheckoutResult

type CheckoutResult string

const (
	CheckoutOk       CheckoutResult = "success"
	CheckoutNotFound CheckoutResult = "not found"
	CheckoutError    CheckoutResult = "error"
)

func (*CheckoutResult) String

func (r *CheckoutResult) String() string

type CloneResult

type CloneResult string

const (
	ClonedSuccessfully CloneResult = "cloned"
	ClonedAlready      CloneResult = "already cloned"
	ClonedAgain        CloneResult = "re-cloned"
	CloneError         CloneResult = "error"
)

func (*CloneResult) String

func (r *CloneResult) String() string

type Commit

type Commit struct {
	Id         string
	AuthorDate time.Time
	Author     CommitUser
	CommitDate time.Time
	Committer  CommitUser
}

type CommitUser

type CommitUser struct {
	Name  string
	Email string
}

func (*CommitUser) String

func (u *CommitUser) String() string

type CreateResult

type CreateResult string

const (
	CreateOk    CreateResult = "created"
	CreateError CreateResult = "error"
)

func (*CreateResult) String

func (r *CreateResult) String() string

type GitService

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

func NewGitService

func NewGitService(sh shell.Shell) GitService

func (*GitService) Checkout

func (g *GitService) Checkout(repo *model.Repo, ref string) (CheckoutResult, error)

func (*GitService) CleanBranches

func (g *GitService) CleanBranches(repo *model.Repo, mode config.GitMode) (string, error)

func (*GitService) CloneRepo

func (g *GitService) CloneRepo(repo *model.Repo, recreate bool) (CloneResult, error)

func (*GitService) Commit

func (g *GitService) Commit(repo *model.Repo, pattern string, message string) error

func (*GitService) CreateBranch

func (g *GitService) CreateBranch(repo *model.Repo, name string) (CreateResult, error)

func (*GitService) Discard

func (g *GitService) Discard(repo *model.Repo) error

func (*GitService) Fetch

func (g *GitService) Fetch(repo *model.Repo) error

func (*GitService) GetBranches

func (g *GitService) GetBranches(repo *model.Repo, mode config.GitMode, pattern string) ([]Branch, error)

func (*GitService) GetDefaultBranch

func (g *GitService) GetDefaultBranch(repo *model.Repo) (*Branch, error)

func (*GitService) GetUnmergedBranches

func (g *GitService) GetUnmergedBranches(repo *model.Repo, mode config.GitMode, ref string) ([]Branch, error)

GetUnmergedBranches returns branches that are not merged to `ref`

func (*GitService) GetUnmergedCommits

func (g *GitService) GetUnmergedCommits(repo *model.Repo, branch Branch, ref string) ([]Commit, error)

GetUnmergedCommits returns commits from branch `branch` that are not merged to ref `ref`. The commits are ordered by `committedAt` attribute Returns an error when `branch` and `ref` don't have a common parent

func (*GitService) Pull

func (g *GitService) Pull(repo *model.Repo) error

func (*GitService) Push

func (g *GitService) Push(repo *model.Repo, branch string, allBranches bool, force bool) error

func (*GitService) RemoveBranch

func (g *GitService) RemoveBranch(repo *model.Repo, branch Branch) error

func (*GitService) Status

func (g *GitService) Status(repo *model.Repo) (StatusResult, string, error)

type StatusResult

type StatusResult string

const (
	StatusClean   StatusResult = "clean"
	StatusDirty   StatusResult = "dirty"
	StatusMissing StatusResult = "missing"
	StatusError   StatusResult = "error"
)

func (*StatusResult) String

func (r *StatusResult) String() string