Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GitFlowTag

This interface represents the basic functionality of a git flow tag.

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly type

type: GitFlowTagType

Specifies the git flow entity type.

Methods

generateTagName

  • generateTagName(): Promise<undefined | string>

  • Generates a default tag name.

    Returns Promise<undefined | string>

list

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

  • Lists all git flow entity of the type 'type'.

    Parameters

    • Optional withPrefix: boolean

      Indicates if the entities should be listed with their prefix.

    Returns Promise<string[]>

start

  • start(baseBranch?: string): Promise<string>

  • Publishs a new tag of the type 'type'.

    Parameters

    • Optional baseBranch: string

      The base branch to create an prerelease from.

    Returns Promise<string>

    The git reference of the create tag.