SignalR Git APIs For Client

GetGitLogs

参数列表

参数	类型	备注
项目名称(projectName)	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node

介绍

该方法被Invoke时，节点会调用Git获取最多近20条Commit记录.

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
logs	list	Commit记录

Commit

参数	类型	备注
Hash	string
Author	string
Email	string
Additions	long
Deletions	long
FilesChange	long
Datetime	long

GetCommitDiff

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
Commit hash	string	Commit 的 hash
介绍

该方法被Invoke时，节点会调用git diff 来获取commit 的修改信息。 等同于 该commit 和 该commit 的 parent 的内容 diff

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	diff 信息 （diff --git 格式）

GetUncommitDiff

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node

介绍

该方法被Invoke时，节点会调用git diff来获取当前分支中未commit的信息。

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	diff 信息 （diff --git 格式）

---

GetGitBranches

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node

介绍

该方法被Invoke时，将运行 git branch 获取分支信息

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
branches	list	每个branch名字组成的数组
nowBranch	string	当前的分支名称

---

SwitchGitBranch

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
目标分支	string	欲切换至的分支

介绍

该方法被Invoke时，节点端将调用git checkout切换分支.

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行 git checkout的结果

---

DeleteGitBranches

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
分支	string	欲删除的分支

介绍

该方法被Invoke时，节点端会调用Git删除指定的分支

注：无法删除当前活动的分支。 返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行git删除指令后的结果

CreateGitBranches

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
branchName	string	分支名称
baseBranchName	string	新分支的父分支 （如果是 "", 将等同于 "master" ）

介绍

该方法被Invoke时，会创建本地分支

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行git指令后的结果

CreateGitCommit

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
标题(title)	string	Git Commit标题
内容(description)	string	Git commit描述

介绍

该方法被Invoke时，节点会调用git commit

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行git删除指令后的结果

CreateGitPush

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
repository	string	通常该值为空
refspec	string	通常该值为空

介绍

该方法被Invoke时，节点会调用git commit <repository> <refspec> 将本地分支推送到远端

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行git删除指令后的结果

CreateGitPull

参数列表

参数	类型	备注
项目名称	string	项目Clone至~/中，假如项目为Polemo.NetCore.Node，该参数传递的是Polemo.NetCore.Node
repository	string	通常该值为空
refspec	string	通常该值为空

介绍

该方法被Invoke时，节点会调用git pull <repository> <refspec> 将拉去远端数据到本地分支

返回值

参数	类型	备注
isSucceeded	bool	是否成功切换
msg	string	运行git删除指令后的结果

---

---

** 远端分支创建和删除 ** 举个例子

创建本地分支 test1
CreateGitBranches(<projectName>, "test1", "")

创建本地分支 test2 rebase test1
CreateGitBranches(<projectName>, "test2", "test1")

创建远端分支 
CreateGitPush(<projectName>,"origin", "test2")
删除远端分支
CreateGitPush(<projectName>,"origin", "--delete test2")