Class GitlabRepoRef

Repository reference implementation for Gitlab

Hierarchy

AbstractRemoteRepoRef
- GitlabRepoRef

Implements

RemoteRepoRef

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new GitlabRepoRef(owner: string, repo: string, sha: string, apiBase?: string, gitlabRemoteUrl?: string, path?: string, branch?: string): GitlabRepoRef

Overrides AbstractRemoteRepoRef.constructor
- Defined in lib/operations/common/GitlabRepoRef.ts:48
Parameters
- owner: string
- repo: string
- sha: string
- Default value apiBase: string = GitlabDotComApiBase
- Default value gitlabRemoteUrl: string = GitlabDotComRemoteUrl
- Optional path: string
- Optional branch: string
Returns GitlabRepoRef

Properties

Readonly apiBase

apiBase: string

API URL without the scheme or trailing '/'.

Optional branch

branch: string

Readonly kind

kind: string = "gitlab"

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

addApproversToMergeRequest

addApproversToMergeRequest(credentials: ProjectOperationCredentials, reviewers: PullRequestReviewer[], mrNumber: number, projectId: number): Promise<void>

- Defined in lib/operations/common/GitlabRepoRef.ts:223
Add Approvers to Merge Request

Parameters
- credentials: ProjectOperationCredentials
- reviewers: PullRequestReviewer[]
- mrNumber: number
  
  The iid of the merge request
- projectId: number
  
  The project id in Gitlab
Returns Promise<void>

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/GitlabRepoRef.ts:60
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/GitlabRepoRef.ts:89
Parameters
- creds: ProjectOperationCredentials
Returns Promise<ActionResult<this>>

getGitlabVersion

getGitlabVersion(credentials: ProjectOperationCredentials): Promise<{ revision: string; version: string }>

- Defined in lib/operations/common/GitlabRepoRef.ts:121
Retrieve the Gitlab Server version

Parameters
- credentials: ProjectOperationCredentials
Returns Promise<{ revision: string; version: string }>

Revision info

getGroupId

getGroupId(credentials: ProjectOperationCredentials, name: string): Promise<number>

- Defined in lib/operations/common/GitlabRepoRef.ts:141
Retrieve the id of the supplied group

Parameters
- credentials: ProjectOperationCredentials
- name: string
Returns Promise<number>

The id of the requested group

Private getNamespaceForOwner

getNamespaceForOwner(owner: string, creds: ProjectOperationCredentials): Promise<number>

- Defined in lib/operations/common/GitlabRepoRef.ts:345
Parameters
- owner: string
- creds: ProjectOperationCredentials
Returns Promise<number>

getUserId

getUserId(credentials: ProjectOperationCredentials, name: string): Promise<number>

- Defined in lib/operations/common/GitlabRepoRef.ts:171
Retrieve the id of the supplied user

Parameters
- credentials: ProjectOperationCredentials
- name: string
Returns Promise<number>

The id of the user

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/GitlabRepoRef.ts:298
Parameters
- credentials: ProjectOperationCredentials
- title: string
- body: string
- head: string
- base: string
- Optional reviewers: PullRequestReviewer[]
Returns Promise<ActionResult<this>>

Private resolveApprovers

resolveApprovers(credentials: ProjectOperationCredentials, reviewers: PullRequestReviewer[]): Promise<{ groups: number[]; users: number[] }>

- Defined in lib/operations/common/GitlabRepoRef.ts:194
Convert reviewers from names to ids

Parameters
- credentials: ProjectOperationCredentials
- reviewers: PullRequestReviewer[]
Returns Promise<{ groups: number[]; users: number[] }>

The user and group ids requested for MR approval

setUserConfig

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

Implementation of RemoteRepoRef.setUserConfig

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

Static from

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

- Defined in lib/operations/common/GitlabRepoRef.ts:33
Parameters
- params: { branch?: string; gitlabRemoteUrl?: string; owner: string; path?: string; rawApiBase?: string; repo: string; sha?: string }
  - Optional branch?: string
  - Optional gitlabRemoteUrl?: string
  - owner: string
  - Optional path?: string
  - Optional rawApiBase?: string
  - repo: string
  - Optional sha?: string
Returns GitlabRepoRef

Generated using TypeDoc