git

Documentation

Index

• Constants
• func BuildCommitChangelog(commitHistory []*model.Commit, progressChan chan *model.ProgressUpdate, ...) ([]*model.Commit, []error)
• func CheckLocalRepoAvailable(dir string) bool
• func ConvertGithubCommitsIntoModel(ghCommits []*APICommit, progressChan chan *model.ProgressUpdate, ...) ([]*model.Commit, []error)
• func ExtractHistoryFromFile(repoDirectory, filePath string, progressChan chan *model.ProgressUpdate, ...) ([]*model.Commit, []error)
• func ExtractPathAndFile(location string) (string, string)
• func GetTopLevel(dir string) (string, error)
• func PopulateHistoryWithChanges(commitHistory []*model.Commit, limit int, ...) ([]*model.Commit, []error)
• func ProcessGithubRepo(username string, repo string, filePath string, ...) ([]*model.Commit, []error)
• type APICommit
  • func GetCommitsForGithubFile(user, repo, path string, progressChan chan *model.ProgressUpdate, ...) ([]*APICommit, error)
• type APICommitAuthor
• type APICommitDetails
• type APIFile

Constants

const (
	GIT       = "git"
	LOG       = "log"
	SHOW      = "show"
	REVPARSE  = "rev-parse"
	TOPLEVEL  = "--show-toplevel"
	NOPAGER   = "--no-pager"
	LOGFORMAT = "--pretty=%cD||%h||%s||%an||%ae"
	DIV       = "--"
)

const GithubAuthHeader = "Authorization"

const GithubRepoAPI = "https://api.github.com/repos/"

const GithubToken = "GH_TOKEN"

Functions

func BuildCommitChangelog

func BuildCommitChangelog(commitHistory []*model.Commit,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, base string, remote bool) ([]*model.Commit, []error)

func CheckLocalRepoAvailable

func CheckLocalRepoAvailable(dir string) bool

func ConvertGithubCommitsIntoModel

func ConvertGithubCommitsIntoModel(ghCommits []*APICommit,
	progressChan chan *model.ProgressUpdate, progressErrorChan chan model.ProgressError, base string, remote bool) ([]*model.Commit, []error)

func ExtractHistoryFromFile

func ExtractHistoryFromFile(repoDirectory, filePath string,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError) ([]*model.Commit, []error)

func ExtractPathAndFile

func ExtractPathAndFile(location string) (string, string)

func GetTopLevel

func GetTopLevel(dir string) (string, error)

func PopulateHistoryWithChanges

func PopulateHistoryWithChanges(commitHistory []*model.Commit, limit int,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, base string, remote bool) ([]*model.Commit, []error)

func ProcessGithubRepo

func ProcessGithubRepo(username string, repo string, filePath string,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError,
	forceCutoff bool, limit int, base string, remote bool) ([]*model.Commit, []error)

Types

type APICommit

type APICommit struct {
	Hash          string            `json:"sha"`
	CommitDetails *APICommitDetails `json:"commit"`
	URL           string            `json:"url"`
	Files         []*APIFile        `json:"files"`
}

func GetCommitsForGithubFile

func GetCommitsForGithubFile(user, repo, path string,
	progressChan chan *model.ProgressUpdate, progressErrorChan chan model.ProgressError,
	forceCutoff bool, limit int) ([]*APICommit, error)

type APICommitAuthor

type APICommitAuthor struct {
	Name  string `json:"name"`
	Email string `json:"email"`
	Date  string `json:"date"`
}

type APICommitDetails

type APICommitDetails struct {
	Author  *APICommitAuthor `json:"author"`
	Message string           `json:"message"`
	URL     string           `json:"url"`
}

type APIFile

type APIFile struct {
	RawURL  string `json:"raw_url"`
	BlobURL string `json:"blob_url"`
	Hash    string `json:"sha"`
	Bytes   []byte `json:"-"`
}