Class AvhGitFlow

Implementation of git flow by gitflow-avh.

Hierarchy

AvhGitFlow

Implements

GitFlow

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AvhGitFlow(repoPath?: string): AvhGitFlow

Initializes a new instance of this class.

Parameters
- Optional repoPath: string
  
  The path to the git repository.
Returns AvhGitFlow

Properties

Readonly bugfix

bugfix: GitFlowBranch

Provides functionality of bugfix branches.

Readonly config

config: ConfigProvider<GitFlowConfig>

Provides functionality to get and set the git flow configuration.

Readonly feature

feature: GitFlowBranch

Provides functionality of feature branches.

Readonly hotfix

hotfix: GitFlowBranch

Provides functionality of hotfix branches.

Readonly release

release: GitFlowBranch

Provides functionality of release branches.

Readonly support

support: GitFlowBranch

Provides functionality of support branches.

Methods

init

init(config?: GitFlowConfig, force?: boolean): Promise<void>

Implementation of GitFlow.init

{@inheritdoc}

Parameters
- Optional config: GitFlowConfig
  
  The git flow configuration.
- Optional force: boolean
  
  Force reinitialisation if git flow already initialized.
Returns Promise<void>

version

version(): Promise<string>

Implementation of GitFlow.version

{@inheritdoc}

Returns Promise<string>
The AVH git flow version.