Documentation
¶
Overview ¶
Package git Main package of the git commands.
Reference: https://git-scm.com/docs/
Index ¶
- func Add(options ...types.Option) (string, error)
- func Branch(options ...types.Option) (string, error)
- func Checkout(options ...types.Option) (string, error)
- func Clone(options ...types.Option) (string, error)
- func CmdExecutor(executor types.Executor) types.Option
- func Commit(options ...types.Option) (string, error)
- func Cond(apply bool, options ...types.Option) types.Option
- func Config(options ...types.Option) (string, error)
- func Debug(g *types.Cmd)
- func Debugger(debug bool) types.Option
- func Fetch(options ...types.Option) (string, error)
- func Init(options ...types.Option) (string, error)
- func LogOutput(w io.Writer) types.Option
- func Merge(options ...types.Option) (string, error)
- func NoOp(_ *types.Cmd)
- func Pull(options ...types.Option) (string, error)
- func Push(options ...types.Option) (string, error)
- func Raw(cmd string, options ...types.Option) (string, error)
- func Rebase(options ...types.Option) (string, error)
- func Remote(options ...types.Option) (string, error)
- func Reset(options ...types.Option) (string, error)
- func RevParse(options ...types.Option) (string, error)
- func Tag(options ...types.Option) (string, error)
- func Worktree(options ...types.Option) (string, error)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Add ¶ added in v0.17.0
Add https://git-scm.com/docs/git-add
Example ¶
out, _ := Add(add.All, CmdExecutor(cmdExecutorMock)) fmt.Println(out)
Output: git add --all
func Branch ¶ added in v0.6.0
Branch https://git-scm.com/docs/git-branch
Example ¶
out, _ := Branch(branch.DeleteForce, branch.BranchName("myBranch"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git branch -D myBranch
func Checkout ¶
Checkout https://git-scm.com/docs/git-checkout
Example ¶
out, _ := Checkout(checkout.NewBranch("myBranchName"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git checkout -b myBranchName
func Clone ¶
Clone https://git-scm.com/docs/git-clone
Example ¶
out, _ := Clone(clone.Repository("git@github.com:ldez/go-git-cmd-wrapper.git"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git clone git@github.com:ldez/go-git-cmd-wrapper.git
func CmdExecutor ¶ added in v0.22.0
CmdExecutor Allow to override the Git command call (useful for testing purpose)
func Commit ¶ added in v0.16.0
Commit https://git-scm.com/docs/git-commit
Example ¶
out, _ := Commit(commit.Amend, commit.Message("chore: foo"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git commit --amend --message="chore: foo"
func Cond ¶
Cond apply conditionally some options
Example ¶
param := false
out, _ := Push(push.All, Cond(param, push.DryRun), push.FollowTags, push.ReceivePack("aaa"), CmdExecutor(cmdExecutorMock))
fmt.Print(out)
param = true
out, _ = Push(push.All, Cond(param, push.DryRun), push.FollowTags, push.ReceivePack("aaa"), CmdExecutor(cmdExecutorMock))
fmt.Print(out)
Output: git push --all --follow-tags --receive-pack=aaa git push --all --dry-run --follow-tags --receive-pack=aaa
func Config ¶
Config https://git-scm.com/docs/git-config
Example ¶
out, _ := Config(config.Entry("rebase.autoSquash", "true"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git config rebase.autoSquash true
func Fetch ¶
Fetch https://git-scm.com/docs/git-fetch
Example ¶
out, _ := Fetch(fetch.NoTags, fetch.Remote("upstream"), fetch.RefSpec("myBranchName"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git fetch --no-tags upstream myBranchName
func Init ¶
Init https://git-scm.com/docs/git-init
Example ¶
out, _ := Init(ginit.Bare, ginit.Quiet, ginit.Directory("foobar"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git init --bare --quiet foobar
func Merge ¶ added in v0.18.0
Merge https://git-scm.com/docs/git-merge
Example ¶
out, _ := Merge(merge.Squash, merge.Commits("myBranch"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git merge --squash myBranch
func Pull ¶ added in v0.11.0
Pull https://git-scm.com/docs/git-pull
Example ¶
out, _ := Pull(pull.All, pull.Force, pull.Repository("upstream"), pull.Refspec("master"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git pull --all --force upstream master
func Push ¶
Push https://git-scm.com/docs/git-push
Example ¶
out, _ := Push(push.All, push.FollowTags, push.ReceivePack("aaa"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git push --all --follow-tags --receive-pack=aaa
func Rebase ¶
Rebase https://git-scm.com/docs/git-rebase
Example ¶
out, _ := Rebase(rebase.PreserveMerges, rebase.Branch(fmt.Sprintf("%s/%s", "upstream", "master")), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git rebase --preserve-merges upstream/master
func Remote ¶
Remote https://git-scm.com/docs/git-remote
Example ¶
out, _ := Remote(remote.Add("upstream", "git@github.com:johndoe/go-git-cmd-wrapper.git"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git remote add upstream git@github.com:johndoe/go-git-cmd-wrapper.git
func Reset ¶ added in v0.16.0
Reset https://git-scm.com/docs/git-reset
Example ¶
out, _ := Reset(reset.Soft, reset.Commit("e41f083"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git reset --soft e41f083
func RevParse ¶ added in v0.9.0
RevParse https://git-scm.com/docs/git-rev-parse
Example ¶
out, _ := RevParse(revparse.AbbrevRef(""), revparse.Args("HEAD"), CmdExecutor(cmdExecutorMock))
fmt.Println(out)
Output: git rev-parse --abbrev-ref HEAD
func Tag ¶ added in v1.1.0
Tag https://git-scm.com/docs/git-tag
Example ¶
out, _ := Tag(tag.List, CmdExecutor(cmdExecutorMock)) fmt.Println(out)
Output: git tag --list
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.