Options
All
  • Public
  • Public/Protected
  • All
Menu

Identifies a git repo with a remote. Also defines behavior for working with remote, such as raising a pull request or equivalent

Hierarchy

Implemented by

Index

Properties

Optional branch

branch: string

If this is populated, then sha should contain a sha (it may also contain the same branch name, for backwards compatibility)

owner

owner: string

Optional path

path: string

Path from root, using / syntax. If undefined or the empty string, use the root of the repo.

Readonly providerType

providerType: ProviderType

SCM provider of remote repo

Readonly remoteBase

remoteBase: string

Base root remote clone

repo

repo: string

Optional sha

sha: string

Might contain a sha, might contain a ref (for backwards compatibility) Providing a sha here and a branch in branch instead is encouraged.

url

url: string

Entire url of the repo. Can be a file URL if this is local.

Methods

cloneUrl

createRemote

deleteRemote

raisePullRequest

setUserConfig

Generated using TypeDoc