FileSystemRemoteRepoRef | @atomist/sdm-local

RemoteRepoRef working against our expanded directory structure. Supports cloning and pushing.

Hierarchy

AbstractRemoteRepoRef
- FileSystemRemoteRepoRef

Implements

RemoteRepoRef

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FileSystemRemoteRepoRef(opts: object): FileSystemRemoteRepoRef

Overrides AbstractRemoteRepoRef.__constructor
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:125
Parameters
- opts: object
  - Optional branch?: string
  - mergePullRequests: boolean
  - owner: string
  - repo: string
  - repositoryOwnerParentDirectory: string
  - Optional sha?: string
Returns FileSystemRemoteRepoRef

Properties

apiBase

apiBase: string

Optional branch

branch: string

kind

kind: string = "file"

mergePullRequests

mergePullRequests: boolean

owner

owner: string

Optional path

path: string

pathComponent

pathComponent: string

providerType

providerType: ProviderType

remoteBase

remoteBase: string

Remote url not including scheme or trailing '/'

repo

repo: string

repositoryOwnerParentDirectory

repositoryOwnerParentDirectory: string

scheme

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

sha

sha: string

Accessors

fileSystemLocation

get fileSystemLocation(): string

- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:123
Returns string

url

get url(): string

Overrides AbstractRemoteRepoRef.url
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:119
Returns string

Methods

cloneUrl

cloneUrl(): string

Overrides AbstractRemoteRepoRef.cloneUrl
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:115
Returns string

createRemote

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

Overrides AbstractRemoteRepoRef.createRemote
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:77
Parameters
- creds: ProjectOperationCredentials
- description: string
- visibility: any
Returns Promise<ActionResult<this>>

deleteRemote

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

Overrides AbstractRemoteRepoRef.deleteRemote
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:81
Parameters
- creds: ProjectOperationCredentials
Returns Promise<ActionResult<this>>

raisePullRequest

raisePullRequest(creds: ProjectOperationCredentials, title: string, body: string, head: string, base: string): Promise<ActionResult<this>>

Overrides AbstractRemoteRepoRef.raisePullRequest
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:85
Parameters
- creds: ProjectOperationCredentials
- title: string
- body: string
- head: string
- base: string
Returns Promise<ActionResult<this>>

setUserConfig

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

Overrides AbstractRemoteRepoRef.setUserConfig
- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:111
Parameters
- credentials: ProjectOperationCredentials
- project: Configurable
Returns Promise<ActionResult<any>>

Static fromDirectory

fromDirectory(opts: object): FileSystemRemoteRepoRef

- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:47
Parameters
- opts: object
  - baseDir: string
  - Optional branch?: string
  - mergePullRequests: boolean
  - repositoryOwnerParentDirectory: string
  - Optional sha?: string
Returns FileSystemRemoteRepoRef

Static implied

implied(repositoryOwnerParentDirectory: string, mergePullRequests: boolean, owner: string, repo: string): RemoteRepoRef

- Defined in lib/sdm/binding/project/FileSystemRemoteRepoRef.ts:69
Remote RepoRef for the given owner and directory. Not guaranteed to exist.

Parameters
- repositoryOwnerParentDirectory: string
- mergePullRequests: boolean
- owner: string
- repo: string
Returns RemoteRepoRef

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: object

Optional branch?: string

mergePullRequests: boolean

owner: string

repo: string

repositoryOwnerParentDirectory: string

Optional sha?: string

Returns FileSystemRemoteRepoRef

Properties

apiBase

Optional branch

kind

mergePullRequests

owner

Optional path

pathComponent

providerType

remoteBase

repo

repositoryOwnerParentDirectory

scheme

sha

Accessors

fileSystemLocation

Returns string

url

Returns string

Methods

cloneUrl

Returns string

createRemote

Parameters

creds: ProjectOperationCredentials

description: string

visibility: any

Returns Promise<ActionResult<this>>

deleteRemote

Parameters

creds: ProjectOperationCredentials

Returns Promise<ActionResult<this>>

raisePullRequest

Parameters

creds: ProjectOperationCredentials

title: string

body: string

head: string

base: string

Returns Promise<ActionResult<this>>

setUserConfig

Parameters

credentials: ProjectOperationCredentials

project: Configurable

Returns Promise<ActionResult<any>>

Static fromDirectory

Parameters

opts: object

baseDir: string

Optional branch?: string

mergePullRequests: boolean

repositoryOwnerParentDirectory: string

Optional sha?: string

Returns FileSystemRemoteRepoRef

Static implied

Parameters

repositoryOwnerParentDirectory: string

mergePullRequests: boolean

owner: string

repo: string

Returns RemoteRepoRef