GitApi API
The gitApi module of the @codebolt/plugin-sdk.
import plugin from '@codebolt/plugin-sdk';
Quick Reference
| Method | Description |
|---|---|
branch | |
checkout | |
commit | |
createBranch | |
diff | |
download | |
getRemoteUrl | |
graph | |
init | |
publishRemote | |
pull | |
push | |
pushToRemote | |
revert | |
revertUntracked | |
status |
Methods
branch
plugin.gitApi.branch(data?: GitBranchRequest): Promise<GitBranch[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitBranchRequest | No |
Returns: Promise<GitBranch[]>
checkout
plugin.gitApi.checkout(data: GitCheckoutRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitCheckoutRequest | Yes |
Returns: Promise<unknown>
commit
plugin.gitApi.commit(data: GitCommitRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitCommitRequest | Yes |
Returns: Promise<unknown>
createBranch
plugin.gitApi.createBranch(data: GitCreateBranchRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitCreateBranchRequest | Yes |
Returns: Promise<unknown>
diff
plugin.gitApi.diff(data?: GitDiffRequest): Promise<GitDiff[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitDiffRequest | No |
Returns: Promise<GitDiff[]>
download
plugin.gitApi.download(data: GitDownloadRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitDownloadRequest | Yes |
Returns: Promise<unknown>
getRemoteUrl
plugin.gitApi.getRemoteUrl(): Promise<GitRemoteUrlResponse>
No parameters.
Returns: Promise<GitRemoteUrlResponse>
graph
plugin.gitApi.graph(data?: GitGraphRequest): Promise<GitCommit[]>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitGraphRequest | No |
Returns: Promise<GitCommit[]>
init
plugin.gitApi.init(data?: GitInitRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitInitRequest | No |
Returns: Promise<unknown>
publishRemote
plugin.gitApi.publishRemote(data: GitPublishRemoteRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitPublishRemoteRequest | Yes |
Returns: Promise<unknown>
pull
plugin.gitApi.pull(data?: GitPullRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitPullRequest | No |
Returns: Promise<unknown>
push
plugin.gitApi.push(data?: GitPushRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitPushRequest | No |
Returns: Promise<unknown>
pushToRemote
plugin.gitApi.pushToRemote(data?: GitPushRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitPushRequest | No |
Returns: Promise<unknown>
revert
plugin.gitApi.revert(data: GitRevertRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitRevertRequest | Yes |
Returns: Promise<unknown>
revertUntracked
plugin.gitApi.revertUntracked(data: GitRevertRequest): Promise<unknown>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitRevertRequest | Yes |
Returns: Promise<unknown>
status
plugin.gitApi.status(data?: GitStatusRequest): Promise<GitStatus>
| Parameter | Type | Required | Description |
|---|---|---|---|
data | GitStatusRequest | No |
Returns: Promise<GitStatus>