Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GFlow

GitFlow wrapper extending functionality to a common git flow implementation.

Hierarchy

  • GFlow

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of this class.

    Parameters

    • gitFlow: GitFlow

      GitFlow implementation.

    • Optional options: GFlowConfig

      Options for configuring the GFlow.

    Returns GFlow

Properties

alpha

alpha: GitFlowTag

beta

beta: GitFlowTag

bugfix

bugfix: GitFlowBranch

Provides functionality of bugfix branches.

Readonly config

config: ConfigProvider<GitFlowConfig>

Provides functionality to get and set the git flow configuration.

feature

feature: GitFlowBranch

Provides functionality of feature branches.

hotfix

hotfix: GitFlowBranch

Provides functionality of hotfix branches.

Protected Readonly options

options: GFlowConfig

release

release: GitFlowBranch

Provides functionality of release branches.

support

support: GitFlowBranch

Provides functionality of support branches.

Methods

init

  • Setup a git repository for git flow usage.

    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>

    The version of git flow.