Class GitFlowSemVers

Representing an API for handling git flow SemVer.

Hierarchy

GitFlowSemVers

Index

Constructors

constructor

Methods

Constructors

constructor

new GitFlowSemVers(config: ProjectConfig): GitFlowSemVers

Initializes a new instance of this class.

Parameters
- config: ProjectConfig
  
  Base path of the project folder.
Returns GitFlowSemVers

Methods

calculateBranchVersion

calculateBranchVersion(type: GitFlowBranchType, version?: string): Promise<undefined | string>

Calculates the version of the branch created from the current branch.

Parameters
- type: GitFlowBranchType
  
  Type of the branch should be created.
- Optional version: string
  
  A optional custom version to be used.
Returns Promise<undefined | string>
The calculated branch version.

calculateNextPrereleaseVersion

calculateNextPrereleaseVersion(prereleaseType: GitFlowTagType, fromBranch?: GitFlowBranchType): Promise<undefined | string>

Calculates the next prerelease version tag for a given prerelease type.

Parameters
- prereleaseType: GitFlowTagType
  
  The prerelease type.
- fromBranch: GitFlowBranchType = 'release'
  
  The branch the prerelease is started from.
Returns Promise<undefined | string>
The next prerelease version for a given type.