Class GFlowReleaseBranch

This class extending a release branch with some helpful functionality.

Hierarchy

GFlowBranch
- GFlowReleaseBranch

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GFlowReleaseBranch(gitFlowBranch: GitFlowBranch, options?: ProjectConfig): GFlowReleaseBranch

Overrides GFlowBranch.constructor

Initializes a new instance of this class.

Parameters
- gitFlowBranch: GitFlowBranch
  
  Git flow branch to be wrapped.
- Optional options: ProjectConfig
  
  Git flow node project options.
Returns GFlowReleaseBranch

Properties

Readonly defaultBase

defaultBase: GitFlowBaseBranchType

Default base of this branch.

Protected Readonly logger

logger: Logger

Protected Readonly projectConfig

projectConfig: ProjectConfig

Readonly type

type: GitFlowBranchType

Specifies the git flow entity type.

Methods

finish

finish(name?: string, msg?: string): Promise<void>

Overrides GFlowBranch.finish

Merges and finishes the branch of the branch type 'type'.

Parameters
- Optional name: string
  
  Name of the branch to be finished.
- Optional msg: string
  
  Message to be set for finishing the branch.
Returns Promise<void>

generateBranchName

generateBranchName(name?: string): Promise<undefined | string>

Inherited from GFlowBranch.generateBranchName

Generates an default branch name.

Parameters
- Optional name: string
  
  A custom name for the branch.
Returns Promise<undefined | string>
The generated branch name.

Protected generateBranchNameFromConfig

generateBranchNameFromConfig(name: string): Promise<string>

Inherited from GFlowBranch.generateBranchNameFromConfig

Gets the branch name including the git-flow configuration.

Parameters
- name: string
  
  A given branch name without prefix.
Returns Promise<string>
The generated name.

getConfig

getConfig(): Promise<GitFlowBranchConfig>

Inherited from GFlowBranch.getConfig

Gets the git flow branch config.

Returns Promise<GitFlowBranchConfig>
The configuration of the gitex flow branch.

list

list(withPrefix?: boolean): Promise<string[]>

Inherited from GFlowBranch.list

Lists all branches of the type 'type'.

Parameters
- Optional withPrefix: boolean
  
  Indicates if the entities should be listed with their prefix.
Returns Promise<string[]>
The list of branches.

Protected popStashedChanges

popStashedChanges(project: GitFlowNodeProject): Promise<void>

Inherited from GFlowBranch.popStashedChanges

Pops the latest stash into to local repository.

Parameters
- project: GitFlowNodeProject
  
  The git project the stash should be popped from.
Returns Promise<void>

start

start(name?: string, base?: string): Promise<string>

Overrides GFlowBranch.start

Creates and starts a new release branch.

Parameters
- Optional name: string
  
  Name of the branch to be started.
- Optional base: string
  
  Base of the branch should be started from.
Returns Promise<string>
The name of the release branch.

Protected stashChanges

stashChanges(project: GitFlowNodeProject): Promise<boolean>

Inherited from GFlowBranch.stashChanges

Stashes the current local changes.

Parameters
- project: GitFlowNodeProject
  
  The git project to be stashed.
Returns Promise<boolean>
Returns true if changes were stashed. Otherwise false.