git

Documentation

Index

• func APIAuth(creds *common.GitlabCredentials) *http.BasicAuth
• func CommitAndPush(r *git.Repository, u *gl.User, creds *common.GitlabCredentials, msg string)
• func CreateIfNotExists(tree *git.Worktree, file string)
• func CurrentEditor(path string) string
• func MustClone(cmd common.ConfiguredCommand, prj *gl.Project, creds *common.GitlabCredentials) *git.Repository
• func Status(dir string) git.Status
• func StatusMsg(dir string) string
• func TargetRepoBlocks(cmd common.ConfiguredCommand, rc common.RepoCommand) *common.BlockRefs
• func VerifyCloneDir(cmd common.ConfiguredCommand, rc common.RepoCommand) string
• func VerifyEditor(cmd common.ConfiguredCommand, path string, creds *common.GitlabCredentials, ...) error
• type FileInfos
  • func AllLocalRepos(cmd common.ConfiguredCommand) FileInfos
  • func (infos *FileInfos) MaxNameLen() int

Functions

func APIAuth

func APIAuth(creds *common.GitlabCredentials) *http.BasicAuth

returns an auth object for http connections containing a username and a password or an access token.

func CommitAndPush

func CommitAndPush(r *git.Repository, u *gl.User, creds *common.GitlabCredentials, msg string)

for the given git repository commits the current stage with the given commit message and pushes the commit using the given gitlab user and access token.

func CreateIfNotExists

func CreateIfNotExists(tree *git.Worktree, file string)

in the given work tree creates a file with the given name if it doesn't exist yet.

func CurrentEditor

func CurrentEditor(path string) string

will get the current editor of the repository behind 'path' if unset, returns a blank string.

func MustClone

func MustClone(cmd common.ConfiguredCommand, prj *gl.Project, creds *common.GitlabCredentials) *git.Repository

makes sure the given gitlab project is cloned locally (possibly using the given access token for the clone) this also fetches previously unfetched tags and pulls from all remotes returns the git repository.

func Status

func Status(dir string) git.Status

for the given path to a local git repository returns the current git status of its working directory.

func StatusMsg

func StatusMsg(dir string) string

for the given path to a local git repository returns a string representation of the current git status of its working directory.

func TargetRepoBlocks

func TargetRepoBlocks(cmd common.ConfiguredCommand, rc common.RepoCommand) *common.BlockRefs

returns the collection of building blocks added to the currently selected control repository. nolint:gocognit // XXX refactor this monster 🙀 🧐

func VerifyCloneDir

func VerifyCloneDir(cmd common.ConfiguredCommand, rc common.RepoCommand) string

for the given repository command verifies there's a directory for the targeted repository in the local repository directory.

func VerifyEditor

func VerifyEditor(cmd common.ConfiguredCommand, path string, creds *common.GitlabCredentials, force bool) error

will test, if the given gitlab user is the editor of the repository behind 'path' if not, will return an error if force is true, will update the current editor with the given gitlab user.

Types

type FileInfos

type FileInfos []fs.FileInfo

a collection of file infos.

func AllLocalRepos

func AllLocalRepos(cmd common.ConfiguredCommand) FileInfos

contains the collection of files in the default local repository path.

func (*FileInfos) MaxNameLen

func (infos *FileInfos) MaxNameLen() int

for the current file collection contains the length of the longest file name contained.