@pvm/releases
Enumerations
Interfaces
- FollowingReleaseInfo
- GetCurrentReleaseOpts
- MakeReleasesFromWTOpts
- PkgIdentity
- PkgReleaseEntry
- ReleaseData
- ReleaseDataExt
- ReleaseDataMakerOpts
- SoleReleaseInfo
Type aliases
ReleaseLookBack
ฦฌ ReleaseLookBack: FollowingReleaseInfo | SoleReleaseInfo
Defined in
packages/pvm-releases/lib/rline.ts:23
Properties
default
โข default: { configExt: RecursivePartial<Config> ; factory: PluginFactory ; name: string = __filename } | { factory: PluginFactory ; name: string = __filename } | { configExt: RecursivePartial<Config> ; name: string = __filename }
Variables
command
โข command: "download"
Defined in
packages/pvm-releases/cli/pvm-releases-download.ts:8
description
โข description: "Download ReleaseList artifact from remote storage"
Defined in
packages/pvm-releases/cli/pvm-releases-download.ts:9
releaseDataMaker
โข releaseDataMaker: Object
Type declaration
| Name | Type |
|---|---|
fromReleaseContext | (releaseContext: ReleaseContext, opts: ReleaseDataMakerOpts) => Promise<undefined | ReleaseDataExt> |
Defined in
packages/pvm-releases/lib/release-data.ts:14
releaseListMaker
โข releaseListMaker: Object
Type declaration
| Name | Type |
|---|---|
fromWorkingTree | (cwd: string, opts: MakeReleasesFromWTOpts) => Promise<ReleaseData[]> |
Defined in
packages/pvm-releases/lib/release-list.ts:15
Functions
appendReleaseData
โธ appendReleaseData(config, releaseList, releaseData): ReleaseData[]
Parameters
| Name | Type |
|---|---|
config | Config |
releaseList | ReleaseData[] |
releaseData | ReleaseData |
Returns
Defined in
packages/pvm-releases/lib/release-list.ts:64
builder
โธ Const builder(yargs): Argv<{ quiet: boolean } & { force: boolean }>
Parameters
| Name | Type |
|---|---|
yargs | Argv<Object> |
Returns
Argv<{ quiet: boolean } & { force: boolean }>
Defined in
packages/pvm-releases/cli/pvm-releases-download.ts:10
fsAppendReleaseData
โธ fsAppendReleaseData(config, releaseData): void
Parameters
| Name | Type |
|---|---|
config | Config |
releaseData | ReleaseData |
Returns
void
Defined in
packages/pvm-releases/lib/release-list.ts:71
getCurrentRelease
โธ getCurrentRelease(opts?): Promise<Object>
Parameters
| Name | Type |
|---|---|
opts | GetCurrentReleaseOpts |
Returns
Promise<Object>
Defined in
packages/pvm-releases/lib/index.ts:57
handler
โธ Const handler(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | Record<string, any> |
Returns
Promise<void>
Defined in
packages/pvm-releases/cli/pvm-releases-download.ts:24
limitReleaseList
โธ limitReleaseList(releaseList, limit): ReleaseData[]
Parameters
| Name | Type |
|---|---|
releaseList | ReleaseData[] |
limit | ArtifactLimitDef |
Returns
Defined in
packages/pvm-releases/lib/release-list.ts:47
lookBackForReleaseTag
โธ lookBackForReleaseTag(config, releaseTag, isShallow?): ReleaseLookBack
Parameters
| Name | Type |
|---|---|
config | Config |
releaseTag | string |
isShallow | boolean |
Returns
Defined in
packages/pvm-releases/lib/rline.ts:25
makeReleasesFromWorkingTree
โธ makeReleasesFromWorkingTree(cwd, opts?): Promise<ReleaseData[]>
Parameters
| Name | Type |
|---|---|
cwd | string |
opts | MakeReleasesFromWTOpts |
Returns
Promise<ReleaseData[]>
Defined in
packages/pvm-releases/lib/producers/releases-by-working-tree.ts:38
reduceReleaseList
โธ reduceReleaseList(config, releaseList): ReleaseData[]
Parameters
| Name | Type |
|---|---|
config | Config |
releaseList | ReleaseData[] |