Class: VcsPlatform

@pvm/vcs.VcsPlatform

Implements

• VcsOnly

Constructors

constructor

• new VcsPlatform(hostApi, opts?)

Parameters

Name	Type
hostApi	any
opts	VcsConstructorOpts

Defined in

packages/pvm-vcs/lib/vcs.ts:87

Properties

_isSomethingForCommit

• _isSomethingForCommit: boolean = false

Defined in

packages/pvm-vcs/lib/vcs.ts:82

---

_localMode

• _localMode: boolean = false

Defined in

packages/pvm-vcs/lib/vcs.ts:83

---

commitContext

• commitContext: any = null

Defined in

packages/pvm-vcs/lib/vcs.ts:81

---

cwd

• cwd: string

Implementation of

VcsOnly.cwd

Defined in

packages/pvm-vcs/lib/vcs.ts:77

---

gitVcs

• gitVcs: AbstractVcs<GitCommitContext>

Defined in

packages/pvm-vcs/lib/vcs.ts:85

---

hostApi

• hostApi: HostApi

Defined in

packages/pvm-vcs/lib/vcs.ts:79

---

isDryRun

• isDryRun: boolean = false

Implementation of

VcsOnly.isDryRun

Defined in

packages/pvm-vcs/lib/vcs.ts:78

---

mutHostApi

• mutHostApi: HostApi

Defined in

packages/pvm-vcs/lib/vcs.ts:80

---

vcsMode

• vcsMode: "vcs" | "platform"

Defined in

packages/pvm-vcs/lib/vcs.ts:84

Methods

_prepareCommitContext

▸ _prepareCommitContext(): UnknownCommitContext

Returns

UnknownCommitContext

Defined in

packages/pvm-vcs/lib/vcs.ts:138

---

addFiles

▸ addFiles(filePaths): Promise<unknown>

Parameters

Name	Type
filePaths	string[]

Returns

Promise<unknown>

Implementation of

VcsOnly.addFiles

Defined in

packages/pvm-vcs/lib/vcs.ts:143

---

addPath

▸ addPath(path): Promise<unknown>

Parameters

Name	Type
path	string

Returns

Promise<unknown>

Defined in

packages/pvm-vcs/lib/vcs.ts:149

---

addTag

▸ addTag(tagName, ref, opts?): Promise<void>

Parameters

Name	Type
tagName	string
ref	string
opts	AddTagOptions

Returns

Promise<void>

Implementation of

VcsOnly.addTag

Defined in

packages/pvm-vcs/lib/vcs.ts:207

---

addTagAndRelease

▸ addTagAndRelease(ref, tagName, data): Promise<void>

Parameters

Name	Type
ref	string
tagName	string
data	CreateReleasePayload

Returns

Promise<void>

Defined in

packages/pvm-vcs/lib/vcs.ts:217

---

appendFile

▸ appendFile(filePath, content): Promise<unknown>

Parameters

Name	Type
filePath	string
content	string

Returns

Promise<unknown>

Implementation of

VcsOnly.appendFile

Defined in

packages/pvm-vcs/lib/vcs.ts:158

---

beginCommit

▸ beginCommit(): UnknownCommitContext

Returns

UnknownCommitContext

Implementation of

VcsOnly.beginCommit

Defined in

packages/pvm-vcs/lib/vcs.ts:129

---

beginMrAttribution

▸ beginMrAttribution(): Promise<unknown>

Returns

Promise<unknown>

Defined in

packages/pvm-vcs/lib/vcs.ts:269

---

commit

▸ commit(message, opts?): Promise<undefined | CommitResult>

Parameters

Name	Type
message	string
opts	Object

Returns

Promise<undefined | CommitResult>

Implementation of

VcsOnly.commit

Defined in

packages/pvm-vcs/lib/vcs.ts:166

---

createRelease

▸ createRelease(tagName, data): Promise<void>

Parameters

Name	Type
tagName	string
data	ReleasePayload

Returns

Promise<void>

Defined in

packages/pvm-vcs/lib/vcs.ts:211

---

deleteFile

▸ deleteFile(filePath): Promise<unknown>

Parameters

Name	Type
filePath	string

Returns

Promise<unknown>

Implementation of

VcsOnly.deleteFile

Defined in

packages/pvm-vcs/lib/vcs.ts:162

---

dryRun

▸ dryRun(): void

Returns

void

Defined in

packages/pvm-vcs/lib/vcs.ts:96

---

editRelease

▸ editRelease(tagName, data): Promise<void>

Parameters

Name	Type
tagName	string
data	ReleasePayload

Returns

Promise<void>

Defined in

packages/pvm-vcs/lib/vcs.ts:227

---

ensureMrLabels

▸ ensureMrLabels(labels): Promise<unknown>

Parameters

Name	Type
labels	string[]

Returns

Promise<unknown>

Defined in

packages/pvm-vcs/lib/vcs.ts:275

---

fetchLatestSha

▸ fetchLatestSha(refName): Promise<string>

Parameters

Name	Type
refName	string

Returns

Promise<string>

Defined in

packages/pvm-vcs/lib/vcs.ts:253

---

getCommitLink

▸ getCommitLink(commit): Promise<null | string>

Parameters

Name	Type
commit	string

Returns

Promise<null | string>

Defined in

packages/pvm-vcs/lib/vcs.ts:288

---

getCurrentBranch

▸ getCurrentBranch(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-vcs/lib/vcs.ts:199

---

getRelease

▸ getRelease(tagName): Promise<GetReleaseResult>

Parameters

Name	Type
tagName	string

Returns

Promise<GetReleaseResult>

Defined in

packages/pvm-vcs/lib/vcs.ts:241

---

getUpdateHintsByCommit

▸ getUpdateHintsByCommit(commit): Promise<null | Record<string, any>>

Parameters

Name	Type
commit	string

Returns

Promise<null | Record<string, any>>

Defined in

packages/pvm-vcs/lib/vcs.ts:292

---

gitShell

▸ gitShell(cmd, opts?): string

Parameters

Name	Type
cmd	string
opts	Object

Returns

string

Defined in

packages/pvm-vcs/lib/vcs.ts:110

---

isLastAvailableRef

▸ isLastAvailableRef(ref): boolean

Parameters

Name	Type
ref	string

Returns

boolean

Defined in

packages/pvm-vcs/lib/vcs.ts:203

---

isRefMatchesRemoteBranch

▸ isRefMatchesRemoteBranch(targetRef?, branchName): Promise<boolean>

Parameters

Name	Type	Default value
targetRef	string	'HEAD'
branchName	string	undefined

Returns

Promise<boolean>

Defined in

packages/pvm-vcs/lib/vcs.ts:281

---

isSomethingForCommit

▸ isSomethingForCommit(): boolean

Returns

boolean

Implementation of

VcsOnly.isSomethingForCommit

Defined in

packages/pvm-vcs/lib/vcs.ts:114

---

push

▸ push(opts?): Promise<void>

Parameters

Name	Type
opts	PushOptions

Returns

Promise<void>

Implementation of

VcsOnly.push

Defined in

packages/pvm-vcs/lib/vcs.ts:186

---

releaseTagsIterator

▸ releaseTagsIterator(): AsyncIterable<PlatformReleaseTag>

Returns

AsyncIterable<PlatformReleaseTag>

Defined in

packages/pvm-vcs/lib/vcs.ts:249

---

releasesIterator

▸ releasesIterator(): AsyncIterable<VcsRelease>

Returns

AsyncIterable<VcsRelease>

Defined in

packages/pvm-vcs/lib/vcs.ts:245

---

resetCommitContext

▸ resetCommitContext(): void

Returns

void

Defined in

packages/pvm-vcs/lib/vcs.ts:118

---

rollbackCommit

▸ rollbackCommit(commitContext): Promise<void>

Parameters

Name	Type
commitContext	UnknownCommitContext

Returns

Promise<void>

Implementation of

VcsOnly.rollbackCommit

Defined in

packages/pvm-vcs/lib/vcs.ts:123

---

setLocalMode

▸ setLocalMode(): void

Returns

void

Defined in

packages/pvm-vcs/lib/vcs.ts:104

---

syncAttachment

▸ syncAttachment(kind, attachment, opts?): Promise<unknown>

Parameters

Name	Type
kind	string
attachment	Buffer
opts	Object

Returns

Promise<unknown>

Defined in

packages/pvm-vcs/lib/vcs.ts:263

---

syncText

▸ syncText(kind, text): Promise<unknown>

Parameters

Name	Type
kind	string
text	string

Returns

Promise<unknown>

Defined in

packages/pvm-vcs/lib/vcs.ts:257

---

updateFile

▸ updateFile(filePath, content): Promise<unknown>

Parameters

Name	Type
filePath	string
content	string

Returns

Promise<unknown>

Implementation of

VcsOnly.updateFile

Defined in

packages/pvm-vcs/lib/vcs.ts:154

---

upsertRelease

▸ upsertRelease(tagName, data): Promise<void>

Parameters

Name	Type
tagName	string
data	ReleasePayload

Returns

Promise<void>

Defined in

packages/pvm-vcs/lib/vcs.ts:235