Class GFlowAlphaReleaseTag

This class provides functionality to calculate and publish an alpha tag.

Hierarchy

GFlowPreReleaseTag
- GFlowAlphaReleaseTag

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GFlowAlphaReleaseTag(featureBranch: GitFlowBranch, bugfixBranch: GitFlowBranch, options: GFlowConfig): GFlowAlphaReleaseTag

Overrides GFlowPreReleaseTag.constructor

Initializes a new instance of this class.

Parameters
- featureBranch: GitFlowBranch
  
  The git flow feature branch.
- bugfixBranch: GitFlowBranch
  
  The git flow bugfix branch.
- options: GFlowConfig
  
  Gitex flow options.
Returns GFlowAlphaReleaseTag

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>

Inherited from GFlowPreReleaseTag.generateTagName

Generates an the prerelease tag name.

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

list

list(): Promise<string[]>

Inherited from GFlowPreReleaseTag.list

Lists all prerelease tags of the given type.

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

start

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

Overrides GFlowPreReleaseTag.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.