Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "bots/versionbot"

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

GenericPullRequestEvent

GenericPullRequestEvent: PullRequestEvent | PullRequestReviewEvent

Pull request type event.

Variables

IgnoreLabel

IgnoreLabel: "procbots/versionbot/no-checks" = "procbots/versionbot/no-checks"

Label to be applied for VersionBot to ignore the PR.

MergeLabel

MergeLabel: "procbots/versionbot/ready-to-merge" = "procbots/versionbot/ready-to-merge"

Label to be applied for triggering VersionBot to carry out a merge.

RepositoryFilePath

RepositoryFilePath: "repository.yml" = "repository.yml"

Relative (from root) filepath to the VersionBot configuration file in a repository.

ReviewerAddMessage

ReviewerAddMessage: "Please add yourselves as reviewers for this PR." = "Please add yourselves as reviewers for this PR."

Message sent to required reviewers should they not have been added on a review.

WIPLabel

WIPLabel: "flow/in-progress" = "flow/in-progress"

Label denoting the PR is a work in progress and warnings should be suppressed.

fsFileExists

fsFileExists: function = Promise.promisify(FS.stat)

Type declaration

    • (arg1: A1): Bluebird<T>

    • Parameters

      • arg1: A1

      Returns Bluebird<T>

fsReadFile

fsReadFile: function = Promise.promisify(FS.readFile)

Type declaration

    • (filename: string, options?: any): Promise<Buffer | string>

    • Parameters

      • filename: string
      • Optional options: any

      Returns Promise<Buffer | string>

fsWriteFile

fsWriteFile: function = Promise.promisify(FS.writeFile)

Type declaration

    • (path: string, contents: string): Promise<__type>

    • Parameters

      • path: string
      • contents: string

      Returns Promise<__type>

tempCleanup

tempCleanup: function = Promise.promisify(cleanup)

Type declaration

    • (): Bluebird<T>

    • Returns Bluebird<T>

tempMkdir

tempMkdir: function = Promise.promisify(track().mkdir)

Type declaration

    • (arg1: A1): Bluebird<T>

    • Parameters

      • arg1: A1

      Returns Bluebird<T>

Functions

createBot

Object literals

StatusAutoMerge

StatusAutoMerge: object

Status context for automatic (non-manual) merging.

Context

Context: string = "AutoMerges"

Context name.

ManualMerge

ManualMerge: string = "Manual merging is in effect for this PR"

Status context message for the procbots/versionbot/no-checks label.

Pending

Pending: string = "VersionBot should be used to merge PR"

Status context message for automatic merging failure.

Success

Success: string = "PR merging is in progress"

Status context message for automatic merging success.

StatusReviewers

StatusReviewers: object

Status context for reviewers.

Context

Context: string = "Reviewers"

StatusVersionist

StatusVersionist: object

Status context for versionist.

Context

Context: string = "Versionist"

Context name.

Failure

Failure: string = "Missing or forbidden tags in commits, see `repository.yml`"

Status context message for versionist failure.

NoVersioning

NoVersioning: string = "Versioning for this PR is disabled"

Status context message for the procbots/versionbot/no-checks label.

Success

Success: string = "Found all required commit footer tags"

Status context message for versionist success.

Generated using TypeDoc