Class GFlowPreReleaseTag Abstract

This class provides functionality to calculate and publish prerelease tags.

Hierarchy

GFlowPreReleaseTag
- GFlowAlphaReleaseTag
- GFlowBetaReleaseTag

Implements

GitFlowTag

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GFlowPreReleaseTag(type: GitFlowTagType, options?: GFlowConfig): GFlowPreReleaseTag

Initializes a new instance of this class.

Parameters
- type: GitFlowTagType
  
  Git flow tag type.
- Optional options: GFlowConfig
  
  Git flow node project options.
Returns GFlowPreReleaseTag

Properties

Protected Optional baseBranch

baseBranch?: GitFlowBranchType

Protected config

config: GFlowConfig

Protected Readonly logger

logger: Logger

Readonly type

type: GitFlowTagType

Specifies the git flow entity type.

Methods

generateTagName

generateTagName(): Promise<undefined | string>

Implementation of GitFlowTag.generateTagName

Generates an the prerelease tag name.

Returns Promise<undefined | string>
The generated prerelease tag.

list

list(): Promise<string[]>

Implementation of GitFlowTag.list

Lists all prerelease tags of the given type.

Returns Promise<string[]>
The list of prerelease tags.

start

start(baseBranch?: string): Promise<string>

Implementation of GitFlowTag.start

Publishes a prerelease tag of the given type.

Parameters
- Optional baseBranch: string
  
  The base branch to create an prerelease from.
Returns Promise<string>
The name of the created prerelease tag.