@pvm/artifacts
The module provides functionality for loading and unloading release artifacts. In particular changelogs and list of releases. The module is useful if pushing to the master is disabled or versioning is built through git tags and you do not want additional commits to master.
Supported Artifact Types:
- Changelogs
- Release lists
Supported artifact storage types:
- git branch in the repository
Enumerations
Classes
Interfaces
Type aliases
StorageEnumToFrontendClass
ฦฌ StorageEnumToFrontendClass<A>: A extends ReleaseList ? ReleaseListStorage : ChangelogsStorage
Type parameters
| Name | Type |
|---|---|
A | extends ArtifactsStorages |
Defined in
packages/pvm-artifacts/lib/storage-manager.ts:15
TransferDirection
ฦฌ TransferDirection: "upload" | "download"
Defined in
packages/pvm-artifacts/pub/artifacts.ts:13
Properties
default
โข default: { configExt: RecursivePartial<Config> ; factory: PluginFactory ; name: string = __filename } | { factory: PluginFactory ; name: string = __filename } | { configExt: RecursivePartial<Config> ; name: string = __filename }
Variables
cliArtifactsChoices
โข cliArtifactsChoices: string[]
Defined in
packages/pvm-artifacts/cli/common.ts:3
command
โข command: "download <kind>"
Defined in
packages/pvm-artifacts/cli/pvm-artifacts-download.ts:10
description
โข description: "Download a given kind of artifacts from remote storage"
Defined in
packages/pvm-artifacts/cli/pvm-artifacts-download.ts:11
Functions
builder
โธ Const builder(yargs): Argv<{ kind: undefined | string } & { quiet: boolean } & { force: boolean }>
Parameters
| Name | Type |
|---|---|
yargs | Argv<Object> |
Returns
Argv<{ kind: undefined | string } & { quiet: boolean } & { force: boolean }>
Defined in
packages/pvm-artifacts/cli/pvm-artifacts-download.ts:12
download
โธ download(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | ArtifactsTransferArgs |
Returns
Promise<void>
Defined in
packages/pvm-artifacts/pub/artifacts.ts:56
handler
โธ Const handler(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | Record<string, any> |
Returns
Promise<void>
Defined in
packages/pvm-artifacts/cli/pvm-artifacts-download.ts:31
instatiateStorage
โธ instatiateStorage<S>(StorageKlass, deps, storageDef): Promise<InstanceType<S>>
Type parameters
| Name | Type |
|---|---|
S | extends typeof Storage |
Parameters
| Name | Type |
|---|---|
StorageKlass | S |
deps | InitStorageDeps |
storageDef | StorageDef |
Returns
Promise<InstanceType<S>>
Defined in
packages/pvm-artifacts/lib/storage.ts:119
transfer
โธ transfer(__args, direction): Promise<void>
Parameters
| Name | Type |
|---|---|
__args | ArtifactsTransferArgs |
direction | TransferDirection |
Returns
Promise<void>
Defined in
packages/pvm-artifacts/pub/artifacts.ts:15
upload
โธ upload(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | ArtifactsTransferArgs |
Returns
Promise<void>