Class GitHubRepoRef

GitHub repo ref

Hierarchy

AbstractRemoteRepoRef
- GitHubRepoRef

Implements

RemoteRepoRef

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GitHubRepoRef(owner: string, repo: string, sha?: string, rawApiBase?: string, path?: string, branch?: string, rawRemoteBase?: string): GitHubRepoRef

Overrides AbstractRemoteRepoRef.constructor
- Defined in lib/operations/common/GitHubRepoRef.ts:73
Create a GitHubRepoRef instance. It may be easier to use GitHubRepoRef.from.

Parameters
- owner: string
  
  Repo owner
- repo: string
  
  Repo name
- Optional sha: string
  
  Commit SHA to checkout
- Default value rawApiBase: string = GitHubDotComBase
  
  Full GitHub API base URL
- Optional path: string
  
  Path within the Git repository to use as project root
- Optional branch: string
  
  Branch to checkout
- Optional rawRemoteBase: string
  
  Full GitHub remote base URL
Returns GitHubRepoRef

Properties

Readonly apiBase

apiBase: string

Optional branch

branch: string

Readonly kind

kind: string = "github"

Readonly owner

owner: string

Optional Readonly path

path: string

Readonly providerType

providerType: ProviderType

Readonly remoteBase

remoteBase: string

Git remote URL not including scheme or trailing '/'

Readonly repo

repo: string

Readonly scheme

scheme: "http://" | "https://"

URL scheme from applied to both API and remote bases.

Readonly sha

sha: string

Accessors

pathComponent

get pathComponent(): string

Inherited from AbstractRemoteRepoRef.pathComponent
- Defined in lib/operations/common/AbstractRemoteRepoRef.ts:105
Returns string

url

get url(): string

Inherited from AbstractRemoteRepoRef.url
- Defined in lib/operations/common/AbstractRemoteRepoRef.ts:80
Returns string

Methods

addReviewersToPullRequest

addReviewersToPullRequest(credentials: ProjectOperationCredentials, prNumber: string, reviewers: PullRequestReviewer[]): Promise<HttpResponse<any>>

- Defined in lib/operations/common/GitHubRepoRef.ts:149
Used to assign reviewers to existing Pull Requests https://developer.github.com/v3/pulls/review_requests/#create-a-review-request

Parameters
- credentials: ProjectOperationCredentials
- prNumber: string
- reviewers: PullRequestReviewer[]
Returns Promise<HttpResponse<any>>

cloneUrl

cloneUrl(creds: ProjectOperationCredentials): string

Implementation of RemoteRepoRef.cloneUrl

Inherited from AbstractRemoteRepoRef.cloneUrl
- Defined in lib/operations/common/AbstractRemoteRepoRef.ts:84
Parameters
- creds: ProjectOperationCredentials
Returns string

createRemote

createRemote(creds: ProjectOperationCredentials, description: string, visibility: string): Promise<ActionResult<this>>

Overrides AbstractRemoteRepoRef.createRemote
- Defined in lib/operations/common/GitHubRepoRef.ts:98
Parameters
- creds: ProjectOperationCredentials
- description: string
- visibility: string
Returns Promise<ActionResult<this>>

deleteRemote

deleteRemote(creds: ProjectOperationCredentials): Promise<ActionResult<this>>

Implementation of RemoteRepoRef.deleteRemote

Overrides AbstractRemoteRepoRef.deleteRemote
- Defined in lib/operations/common/GitHubRepoRef.ts:245
Parameters
- creds: ProjectOperationCredentials
Returns Promise<ActionResult<this>>

getPr

getPr(credentials: ProjectOperationCredentials, head: string): Promise<any>

- Defined in lib/operations/common/GitHubRepoRef.ts:134
Parameters
- credentials: ProjectOperationCredentials
- head: string
Returns Promise<any>

raisePullRequest

raisePullRequest(credentials: ProjectOperationCredentials, title: string, body: string, head: string, base: string, reviewers?: PullRequestReviewer[]): Promise<ActionResult<this>>

Implementation of RemoteRepoRef.raisePullRequest

Overrides AbstractRemoteRepoRef.raisePullRequest
- Defined in lib/operations/common/GitHubRepoRef.ts:176
Used to create a new Pull Request https://developer.github.com/v3/pulls/#create-a-pull-request

Parameters
- credentials: ProjectOperationCredentials
- title: string
- body: string
- head: string
  
  Source branch
- base: string
  
  Target branch
- Optional reviewers: PullRequestReviewer[]
Returns Promise<ActionResult<this>>

setUserConfig

setUserConfig(credentials: ProjectOperationCredentials, project: Configurable): Promise<ActionResult<any>>

Implementation of RemoteRepoRef.setUserConfig

Overrides AbstractRemoteRepoRef.setUserConfig
- Defined in lib/operations/common/GitHubRepoRef.ts:106
Parameters
- credentials: ProjectOperationCredentials
- project: Configurable
Returns Promise<ActionResult<any>>

Static from

from(params: { branch?: string; owner: string; path?: string; rawApiBase?: string; repo: string; sha?: string }): GitHubRepoRef

- Defined in lib/operations/common/GitHubRepoRef.ts:64
Create a GitHubRepoRef instance.

Parameters
- params: { branch?: string; owner: string; path?: string; rawApiBase?: string; repo: string; sha?: string }
  
  Object with the following properties: owner: Repo owner repo: Repo name sha: Commit SHA to checkout rawApiBase: Full GitHub API base URL path: Path within the Git repository to use as project root branch: Branch to checkout rawRemoteBase: Full GitHub remote base URL
  - Optional branch?: string
  - owner: string
  - Optional path?: string
  - Optional rawApiBase?: string
  - repo: string
  - Optional sha?: string
Returns GitHubRepoRef

Generated using TypeDoc