Class GitHubProvider

constructor

• new GitHubProvider(repo: string): GitHubProvider

  Parameters

  • repo: string

  Returns GitHubProvider

Readonlyplatform

Readonlyrepo

getIssue

• getIssue(number: number): Promise<Result<ScmIssue, ScmError>>

  Parameters

  • number: number

  Returns Promise<Result<ScmIssue, ScmError>>

listIssues

• listIssues(
      filters?: IssueFilters,
  ): Promise<Result<readonly ScmIssue[], ScmError>>

  Parameters

  • Optionalfilters: IssueFilters

  Returns Promise<Result<readonly ScmIssue[], ScmError>>

addLabels

• addLabels(
      issueNumber: number,
      labels: readonly string[],
  ): Promise<Result<void, ScmError>>

  Parameters

  • issueNumber: number
  • labels: readonly string[]

  Returns Promise<Result<void, ScmError>>

createPR

• createPR(options: CreatePROptions): Promise<Result<ScmPullRequest, ScmError>>

  Parameters

  • options: CreatePROptions

  Returns Promise<Result<ScmPullRequest, ScmError>>

mergePR

• mergePR(
      prNumber: number,
      options?: MergePROptions,
  ): Promise<Result<void, ScmError>>

  Parameters

  • prNumber: number
  • Optionaloptions: MergePROptions

  Returns Promise<Result<void, ScmError>>

getPRStatus

• getPRStatus(prNumber: number): Promise<Result<ScmPRStatus, ScmError>>

  Parameters

  • prNumber: number

  Returns Promise<Result<ScmPRStatus, ScmError>>

createIssue

• createIssue(
      title: string,
      body: string,
      labels?: readonly string[],
  ): Promise<Result<ScmIssue, ScmError>>

  Parameters

  • title: string
  • body: string
  • Optionallabels: readonly string[]

  Returns Promise<Result<ScmIssue, ScmError>>

addComment

• addComment(issueNumber: number, body: string): Promise<Result<void, ScmError>>

  Parameters

  • issueNumber: number
  • body: string

  Returns Promise<Result<void, ScmError>>

listComments

• listComments(
      issueNumber: number,
  ): Promise<Result<readonly ScmComment[], ScmError>>

  Parameters

  • issueNumber: number

  Returns Promise<Result<readonly ScmComment[], ScmError>>