git

Documentation

Index

• Variables
• type Action
  • func ActionStatusFromString(key string) *Action
• type Actions
• type HistoryEntries
  • func ParseResultsDelimited(output string) (HistoryEntries, error)
  • func (h HistoryEntries) Get(sha string) *HistoryEntry
• type HistoryEntry
  • func (h *HistoryEntry) OccurredTime() *time.Time
• type HistoryFile
• type HistoryFiles
• type HistoryResult
• type Result
  • func NewResult(prj *project.Project, status string, data util.ValueMap) *Result
  • func (r *Result) Actions() Actions
  • func (r *Result) CleanData() util.ValueMap
  • func (r *Result) DataInt(k string) int
  • func (r *Result) DataString(k string) string
  • func (r *Result) DataStringArray(k string) []string
  • func (r *Result) History() *HistoryResult
  • func (r *Result) Strings() []string
  • func (r *Result) ToCSV() ([]string, [][]string)
• type Results
  • func (r Results) Get(key string) *Result
  • func (r Results) ToCSV() ([]string, [][]string)
• type Service
  • func NewService() *Service
  • func (s *Service) Commit(ctx context.Context, prj *project.Project, msg string, logger util.Logger) (*Result, error)
  • func (s *Service) CreateRepo(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) Fetch(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) History(ctx context.Context, prj *project.Project, hist *HistoryResult, ...) (*Result, error)
  • func (s *Service) Magic(ctx context.Context, prj *project.Project, message string, dryRun bool, ...) (*Result, error)
  • func (s *Service) Outdated(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) Pull(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) Push(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) Reset(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) Status(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)
  • func (s *Service) UndoCommit(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

Variables

var (
	ActionStatus     = &Action{Key: "status", Title: "Status", Description: "Returns the status of the repository"}
	ActionCreateRepo = &Action{Key: "createrepo", Title: "Create Repo", Description: "Creates a git repo and makes an initial commit"}
	ActionMagic      = &Action{Key: "magic", Title: "Magic", Description: "Does everything it can to bring the repo up to date (stash, pull, pop, commit, push)"}
	ActionFetch      = &Action{Key: "fetch", Title: "Fetch", Description: "Fetches the latest changes from the repository"}
	ActionCommit     = &Action{Key: "commit", Title: "Commit", Description: "Adds all files, commits with the provided message"}
	ActionPull       = &Action{Key: "pull", Title: "Pull", Description: "Pulls pending commits from upstream"}
	ActionPush       = &Action{Key: "push", Title: "Push", Description: "Pushes pending commits to the remote"}
	ActionReset      = &Action{Key: "reset", Title: "Reset", Description: "Resets all local changes; be careful"}
	ActionBranch     = &Action{Key: "branch", Title: "Branch", Description: "Switch to a new branch"}
	ActionUndoCommit = &Action{Key: "undocommit", Title: "Undo", Description: "Removes the most recent commit, keeping all local changes"}
	ActionOutdated   = &Action{Key: "outdated", Title: "Outdated", Description: "Finds commits since last tag"}
	ActionHistory    = &Action{Key: "history", Title: "History", Description: "Visualize the git history"}
)

var ResultFields = []string{"Project", "Status", "Data", "Error"}

Types

type Action

type Action struct {
	Key         string `json:"key"`
	Title       string `json:"title"`
	Description string `json:"description"`
}

func ActionStatusFromString

func ActionStatusFromString(key string) *Action

type Actions

type Actions []*Action

type HistoryEntries

type HistoryEntries []*HistoryEntry

func ParseResultsDelimited

func ParseResultsDelimited(output string) (HistoryEntries, error)

func (HistoryEntries) Get

func (h HistoryEntries) Get(sha string) *HistoryEntry

type HistoryEntry

type HistoryEntry struct {
	Headers     util.ValueMap `json:"headers" xml:"headers"`
	SHA         string        `json:"sha" xml:"sha"`
	AuthorName  string        `json:"authorName" xml:"authorName"`
	AuthorEmail string        `json:"authorEmail" xml:"authorEmail"`
	Message     string        `json:"message" xml:"message"`
	Occurred    string        `json:"occurred" xml:"occurred"`
	Files       HistoryFiles  `json:"files" xml:"files"`
}

func (*HistoryEntry) OccurredTime

func (h *HistoryEntry) OccurredTime() *time.Time

type HistoryFile

type HistoryFile struct {
	Status string
	File   string
}

type HistoryFiles

type HistoryFiles []*HistoryFile

type HistoryResult

type HistoryResult struct {
	Path    string         `json:"path,omitempty"`
	Since   *time.Time     `json:"since,omitempty"`
	Authors []string       `json:"authors,omitempty"`
	Limit   int            `json:"limit,omitempty"`
	Commit  string         `json:"commit,omitempty"`
	Entries HistoryEntries `json:"entries"`
	Debug   any            `json:"debug,omitempty"`
}

type Result

type Result struct {
	Project *project.Project `json:"-"`
	Status  string           `json:"status"`
	Data    util.ValueMap    `json:"data"`
	Error   string           `json:"error"`
}

func NewResult

func NewResult(prj *project.Project, status string, data util.ValueMap) *Result

func (*Result) Actions

func (r *Result) Actions() Actions

func (*Result) CleanData

func (r *Result) CleanData() util.ValueMap

func (*Result) DataInt

func (r *Result) DataInt(k string) int

func (*Result) DataString

func (r *Result) DataString(k string) string

func (*Result) DataStringArray

func (r *Result) DataStringArray(k string) []string

func (*Result) History

func (r *Result) History() *HistoryResult

func (*Result) Strings

func (r *Result) Strings() []string

func (*Result) ToCSV

func (r *Result) ToCSV() ([]string, [][]string)

type Results

type Results []*Result

func (Results) Get

func (r Results) Get(key string) *Result

func (Results) ToCSV

func (r Results) ToCSV() ([]string, [][]string)

type Service

type Service struct{}

func NewService

func NewService() *Service

func (*Service) Commit

func (s *Service) Commit(ctx context.Context, prj *project.Project, msg string, logger util.Logger) (*Result, error)

func (*Service) CreateRepo

func (s *Service) CreateRepo(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) Fetch

func (s *Service) Fetch(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) History

func (s *Service) History(ctx context.Context, prj *project.Project, hist *HistoryResult, logger util.Logger) (*Result, error)

func (*Service) Magic

func (s *Service) Magic(ctx context.Context, prj *project.Project, message string, dryRun bool, logger util.Logger) (*Result, error)

func (*Service) Outdated

func (s *Service) Outdated(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) Pull

func (s *Service) Pull(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) Push

func (s *Service) Push(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) Reset

func (s *Service) Reset(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) Status

func (s *Service) Status(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)

func (*Service) UndoCommit

func (s *Service) UndoCommit(ctx context.Context, prj *project.Project, logger util.Logger) (*Result, error)