cn.orionsec.kit.ext.vcs.git

Class Gits

java.lang.Object

cn.orionsec.kit.ext.vcs.git.Gits

All Implemented Interfaces:

SafeCloseable, Closeable, AutoCloseable

public abstract class Gits
extends Object
implements SafeCloseable

git 本地仓库基本操作

checkout pull reset log branch clean

其他功能请用命令行

Since:

2021/7/2 10:15

Version:

1.0.0

Author:

Jiahang Li

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Gits(org.eclipse.jgit.api.Git git)

Method Summary

Modifier and Type	Method and Description
Gits	auth(String username, char[] password) 认证用户
Gits	auth(String username, String password)
List<BranchInfo>	branchList()
List<BranchInfo>	branchList(String branch) 分支列表
Gits	checkout(String branchName) 检出分支
Gits	clean() 清空工作目录其他文件
static Gits	clone(String url, File path)
static Gits	clone(String url, File path, String username, char[] password) clone 仓库 可以使用 accessToken github username: token password: '' github username: '' password: token gitee username: username password: token gitlab username: oauth2 password: token url: https://oauth2:token@url
static Gits	clone(String url, File path, String username, String password)
void	close() 安全关闭
Gits	fetch()
Gits	fetch(String remote) fetch
String	getBranch() 获取当前分支
String	getDirectory() 获取目录
org.eclipse.jgit.api.Git	getGit()
org.eclipse.jgit.lib.Ref	getRef(String name) 获取ref
String	getRemoteUrl() 获取远程url
org.eclipse.jgit.lib.Repository	getRepository()
boolean	hasRef(String name) 检查ref
List<LogInfo>	logList()
List<LogInfo>	logList(int count)
List<LogInfo>	logList(String branch)
List<LogInfo>	logList(String branch, int count)
static Gits	of(File path)
static Gits	of(org.eclipse.jgit.api.Git git)
static Gits	of(org.eclipse.jgit.lib.Repository repo)
Gits	pull()
Gits	pull(String remote)
Gits	pull(String remote, String remoteBranch) pull
Gits	push(String remote) push
Gits	rebase()
Gits	rebase(org.eclipse.jgit.api.RebaseCommand.Operation operation) rebase
Gits	reset(String commitId)
Gits	reset(String commitId, org.eclipse.jgit.api.ResetCommand.ResetType type) 还原版本

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Gits

protected Gits(org.eclipse.jgit.api.Git git)

Method Detail

of

public static Gits of(org.eclipse.jgit.api.Git git)

of

public static Gits of(File path)

of

public static Gits of(org.eclipse.jgit.lib.Repository repo)

clone

public static Gits clone(String url,
                         File path)

clone

public static Gits clone(String url,
                         File path,
                         String username,
                         String password)

clone

public static Gits clone(String url,
                         File path,
                         String username,
                         char[] password)

clone 仓库

可以使用 accessToken

github username: token password: '' github username: '' password: token gitee username: username password: token gitlab username: oauth2 password: token url: https://oauth2:token@url

Parameters:

url - remoteUrl

path - 本地路径

username - 用户名

password - 密码

Returns:

Gits

auth

public Gits auth(String username,
                 String password)

auth

public Gits auth(String username,
                 char[] password)

认证用户

Parameters:

username - username

password - password

Returns:

this

checkout

public Gits checkout(String branchName)

检出分支

Parameters:

branchName - 分支名称

Returns:

this

pull

public Gits pull()

pull

public Gits pull(String remote)

pull

public Gits pull(String remote,
                 String remoteBranch)

pull

Parameters:

remote - 远程主机

remoteBranch - 远程分支

Returns:

this

push

public Gits push(String remote)

push

Parameters:

remote - 远程主机

Returns:

this

fetch

public Gits fetch()

fetch

public Gits fetch(String remote)

fetch

Parameters:

remote - 远程主机

Returns:

this

rebase

public Gits rebase()

rebase

public Gits rebase(org.eclipse.jgit.api.RebaseCommand.Operation operation)

rebase

Parameters:

operation - operation

Returns:

this

reset

public Gits reset(String commitId)

reset

public Gits reset(String commitId,
                  org.eclipse.jgit.api.ResetCommand.ResetType type)

还原版本

Parameters:

commitId - commitId

type - 类型

Returns:

this

branchList

public List<BranchInfo> branchList()

branchList

public List<BranchInfo> branchList(String branch)

分支列表

Parameters:

branch - 分支名称

Returns:

list

logList

public List<LogInfo> logList()

logList

public List<LogInfo> logList(int count)

logList

public List<LogInfo> logList(String branch)

logList

public List<LogInfo> logList(String branch,
                             int count)

clean

public Gits clean()

清空工作目录其他文件

Returns:

return

getDirectory

public String getDirectory()

获取目录

Returns:

目录

getRemoteUrl

public String getRemoteUrl()

获取远程url

Returns:

url

getBranch

public String getBranch()

获取当前分支

Returns:

branch

hasRef

public boolean hasRef(String name)

检查ref

Parameters:

name - name

Returns:

ref

getRef

public org.eclipse.jgit.lib.Ref getRef(String name)

获取ref

Parameters:

name - name

Returns:

ref

getGit

public org.eclipse.jgit.api.Git getGit()

getRepository

public org.eclipse.jgit.lib.Repository getRepository()

close

public void close()

Description copied from interface: SafeCloseable

安全关闭

Specified by:

close in interface SafeCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable