Interface: AbstractVcs<TCommitContext>
@pvm/types.AbstractVcs
Type parameters
Name |
---|
TCommitContext |
Hierarchy
FileCommitApi
<TCommitContext
>↳
AbstractVcs
Methods
addFiles
â–¸ addFiles(commitContext
, filePaths
): void
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
filePaths | string [] |
Returns
void
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:54
addTag
â–¸ addTag(tag_name
, ref
): Promise
<unknown
>
Parameters
Name | Type |
---|---|
tag_name | string |
ref | string |
Returns
Promise
<unknown
>
Defined in
packages/pvm-types/lib/vcs.ts:65
appendFile
â–¸ appendFile(commitContext
, filePath
, content
): void
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
filePath | string |
content | string |
Returns
void
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:55
beginCommit
â–¸ beginCommit(): TCommitContext
Returns
TCommitContext
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:56
commit
â–¸ commit(commitContext
, message
, opts?
): Promise
<CommitResult
>
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
message | string |
opts? | CommitOptions |
Returns
Promise
<CommitResult
>
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:60
deleteFile
â–¸ deleteFile(commitContext
, file_path
): void
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
file_path | string |
Returns
void
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:59
dryRun
â–¸ dryRun(): void
Returns
void
Defined in
packages/pvm-types/lib/vcs.ts:67
fetchLatestSha
â–¸ fetchLatestSha(refName
): Promise
<string
>
Parameters
Name | Type |
---|---|
refName | string |
Returns
Promise
<string
>
Defined in
packages/pvm-types/lib/vcs.ts:64
getCurrentBranch
â–¸ getCurrentBranch(): string
| void
Returns
string
| void
Defined in
packages/pvm-types/lib/vcs.ts:68
getHeadRev
â–¸ getHeadRev(): string
Returns
string
Defined in
packages/pvm-types/lib/vcs.ts:69
isLastAvailableRef
â–¸ isLastAvailableRef(rev
): boolean
Parameters
Name | Type |
---|---|
rev | string |
Returns
boolean
Defined in
packages/pvm-types/lib/vcs.ts:70
push
â–¸ push(opts?
): Promise
<void
>
Parameters
Name | Type |
---|---|
opts? | PushOptions |
Returns
Promise
<void
>
Defined in
packages/pvm-types/lib/vcs.ts:66
rollbackCommit
â–¸ rollbackCommit(commitContext
): Promise
<void
>
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
Returns
Promise
<void
>
Inherited from
Defined in
packages/pvm-types/lib/vcs.ts:57
updateFile
â–¸ updateFile(commitContext
, file_path
, content
): void
Parameters
Name | Type |
---|---|
commitContext | TCommitContext |
file_path | string |
content | string |
Returns
void