Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GFlowHotFixBranch

This class extending a hotfix branch with some helpful functionality.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

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>

  • 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>

  • 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>

  • 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

list

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

  • 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

start

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

  • Creates and starts a new hotfix 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 hotfix branch.

Protected stashChanges

  • Stashes the current local changes.

    Parameters

    Returns Promise<boolean>

    Returns true if changes were stashed. Otherwise false.