Skip to main content

@pvm/add-tag

Provides a node api for getting a new release tag and a cli api for adding a release tag to a commit. @pvm/add-tag only add tag and not generating any additional stuff like changelogs and other artifacts what @pvm/update do.

Properties

default

โ€ข default: { configExt: RecursivePartial<Config> ; factory: PluginFactory ; name: string = __filename } | { factory: PluginFactory ; name: string = __filename } | { configExt: RecursivePartial<Config> ; name: string = __filename }

Variables

builder

โ€ข builder: Object = {}

Defined in

packages/pvm-add-tag/cli/pvm-add-tag.ts:11


command

โ€ข command: "add-tag"

Defined in

packages/pvm-add-tag/cli/pvm-add-tag.ts:9


description

โ€ข description: "Creates a new release tag via GitLab API based on commits made after the last release tag"

Defined in

packages/pvm-add-tag/cli/pvm-add-tag.ts:10

Functions

getNewTag

โ–ธ getNewTag(config, targetRef?): Promise<string | null>

Parameters

NameTypeDefault value
configConfigundefined
targetRefstring'HEAD'

Returns

Promise<string | null>

Defined in

packages/pvm-add-tag/lib/get-new-tag.ts:9


handler

โ–ธ Const handler(): Promise<void>

Returns

Promise<void>

Defined in

packages/pvm-add-tag/cli/pvm-add-tag.ts:12