Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GitFlow

Specification of the git flow API.

Hierarchy

  • GitFlow

Implemented by

Index

Properties

Methods

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

  • Setup a git repository for git flow ussage.

    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>

  • Provides the version of the git flow implementation.

    Returns Promise<string>