@pvm/changelog
Enumerations
Interfaces
Variables
command
• command: "download"
Defined in
packages/pvm-changelog/cli/pvm-changelog-download.ts:8
description
• description: "Download Changelog artifacts from remote storage"
Defined in
packages/pvm-changelog/cli/pvm-changelog-download.ts:9
getRenderer
• getRenderer: MemoizedFunction<[cwd: string, rendererTarget: RenderTarget], Promise<Renderer | IncrementalRenderer>>
Defined in
packages/pvm-changelog/lib/index.ts:74
Functions
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-changelog/cli/pvm-changelog-download.ts:10
default
▸ default(body, tagHeadLevel?): string
Parameters
| Name | Type | Default value |
|---|---|---|
body | string | undefined |
tagHeadLevel | number | 2 |
Returns
string
Defined in
packages/pvm-changelog/lib/indent-headings.ts:4
getRendererPure
▸ getRendererPure(cwd, rendererTarget?): Promise<Renderer | IncrementalRenderer>
Parameters
| Name | Type | Default value |
|---|---|---|
cwd | string | undefined |
rendererTarget | RenderTarget | RenderTarget.changelog |
Returns
Promise<Renderer | IncrementalRenderer>
Defined in
packages/pvm-changelog/lib/index.ts:33
handler
▸ Const handler(args): Promise<void>
Parameters
| Name | Type |
|---|---|
args | Record<string, any> |
Returns
Promise<void>
Defined in
packages/pvm-changelog/cli/pvm-changelog-download.ts:24
mainChangelog
▸ mainChangelog(config, releaseData?): Promise<string>
Parameters
| Name | Type |
|---|---|
config | Config |
releaseData? | ReleaseData |
Returns
Promise<string>
Defined in
packages/pvm-changelog/lib/index.ts:186
makeChangelog
▸ makeChangelog(config, releaseData?): Promise<void>
Parameters
| Name | Type |
|---|---|
config | Config |
releaseData? | ReleaseData |
Returns
Promise<void>
Defined in
packages/pvm-changelog/lib/index.ts:216
pkgChangelogPath
▸ pkgChangelogPath(config, pkg): string
Parameters
| Name | Type |
|---|---|
config | Config |
pkg | Pkg |
Returns
string
Defined in
packages/pvm-changelog/lib/rules.ts:7
renderReleaseContext
▸ renderReleaseContext(releaseContext, renderTarget, forPkg?): Promise<string>
Parameters
| Name | Type |
|---|---|
releaseContext | ReleaseContext |
renderTarget | RenderTarget |
forPkg | void | Pkg |
Returns
Promise<string>