Class CheckGroup

constructor

• new CheckGroup(pullRequestNumber, config, context, sha, startTime): CheckGroup

• Parameters

  • pullRequestNumber: number
  • config: CheckGroupConfig
  • context: Context<"pull_request"> | Context<"check_run">
  • sha: string
  • startTime: string

  Returns CheckGroup

config

context

pullRequestNumber

sha

startTime

files

• files(): Promise<string[]>

• Gets a list of files that are modified in a pull request.

  Returns Promise<string[]>

getPostedChecks

• getPostedChecks(sha): Promise<Record<string, string>>

• Fetches a list of already finished checks.

  Parameters

  • sha: string

    The sha of the commit to check

  Returns Promise<Record<string, string>>

postFailingCheck

• postFailingCheck(name, title, summary, details): Promise<void>

• Parameters

  • name: string
  • title: string
  • summary: string
  • details: string

  Returns Promise<void>

postPassingCheck

• postPassingCheck(name, title, summary, details): Promise<void>

• Parameters

  • name: string
  • title: string
  • summary: string
  • details: string

  Returns Promise<void>

postStartingCheck

• postStartingCheck(name, title, summary, details): Promise<void>

• Post a starting check

  Parameters

  • name: string
  • title: string
  • summary: string
  • details: string

  Returns Promise<void>

postUpdatingCheck

• postUpdatingCheck(name, title, summary, details): Promise<void>

• Parameters

  • name: string
  • title: string
  • summary: string
  • details: string

  Returns Promise<void>

run

• run(): Promise<void>

• Returns Promise<void>