GitLab

GitLab module for RobinPath.

Package: @robinpath/gitlab | Category: Devops | Type: Integration

Authentication

gitlab.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the gitlab module when you need to:

• listProjects -- Use gitlab.listProjects to perform this operation
• getProject -- Use gitlab.getProject to perform this operation
• createProject -- Use gitlab.createProject to perform this operation
• deleteProject -- Use gitlab.deleteProject to perform this operation
• listIssues -- Use gitlab.listIssues to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure gitlab credentials.	object
listProjects	listProjects	object
getProject	getProject	object
createProject	createProject	object
deleteProject	deleteProject	object
listIssues	listIssues	object
getIssue	getIssue	object
createIssue	createIssue	object
updateIssue	updateIssue	object
listMergeRequests	listMergeRequests	object
getMergeRequest	getMergeRequest	object
createMergeRequest	createMergeRequest	object
updateMergeRequest	updateMergeRequest	object
mergeMergeRequest	mergeMergeRequest	object
listBranches	listBranches	object
createBranch	createBranch	object
deleteBranch	deleteBranch	object
listPipelines	listPipelines	object
getPipeline	getPipeline	object
retryPipeline	retryPipeline	object
cancelPipeline	cancelPipeline	object
listCommits	listCommits	object
listTags	listTags	object
createTag	createTag	object
listMembers	listMembers	object
addMember	addMember	object
getUser	getUser	object
searchProjects	searchProjects	object
listEnvironments	listEnvironments	object

Functions

setCredentials

Configure gitlab credentials.

Module: gitlab | Returns: object -- API response.

gitlab.setCredentials

Parameter	Type	Required	Description
host	string	Yes	host
privateToken	string	Yes	privateToken

---

listProjects

listProjects

Module: gitlab | Returns: object -- API response.

gitlab.listProjects

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getProject

getProject

Module: gitlab | Returns: object -- API response.

gitlab.getProject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createProject

createProject

Module: gitlab | Returns: object -- API response.

gitlab.createProject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteProject

deleteProject

Module: gitlab | Returns: object -- API response.

gitlab.deleteProject

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listIssues

listIssues

Module: gitlab | Returns: object -- API response.

gitlab.listIssues

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getIssue

getIssue

Module: gitlab | Returns: object -- API response.

gitlab.getIssue

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createIssue

createIssue

Module: gitlab | Returns: object -- API response.

gitlab.createIssue

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateIssue

updateIssue

Module: gitlab | Returns: object -- API response.

gitlab.updateIssue

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMergeRequests

listMergeRequests

Module: gitlab | Returns: object -- API response.

gitlab.listMergeRequests

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMergeRequest

getMergeRequest

Module: gitlab | Returns: object -- API response.

gitlab.getMergeRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createMergeRequest

createMergeRequest

Module: gitlab | Returns: object -- API response.

gitlab.createMergeRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateMergeRequest

updateMergeRequest

Module: gitlab | Returns: object -- API response.

gitlab.updateMergeRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

mergeMergeRequest

mergeMergeRequest

Module: gitlab | Returns: object -- API response.

gitlab.mergeMergeRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listBranches

listBranches

Module: gitlab | Returns: object -- API response.

gitlab.listBranches

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createBranch

createBranch

Module: gitlab | Returns: object -- API response.

gitlab.createBranch

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteBranch

deleteBranch

Module: gitlab | Returns: object -- API response.

gitlab.deleteBranch

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPipelines

listPipelines

Module: gitlab | Returns: object -- API response.

gitlab.listPipelines

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getPipeline

getPipeline

Module: gitlab | Returns: object -- API response.

gitlab.getPipeline

Parameter	Type	Required	Description
input	string	No	Input parameter

---

retryPipeline

retryPipeline

Module: gitlab | Returns: object -- API response.

gitlab.retryPipeline

Parameter	Type	Required	Description
input	string	No	Input parameter

---

cancelPipeline

cancelPipeline

Module: gitlab | Returns: object -- API response.

gitlab.cancelPipeline

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCommits

listCommits

Module: gitlab | Returns: object -- API response.

gitlab.listCommits

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTags

listTags

Module: gitlab | Returns: object -- API response.

gitlab.listTags

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTag

createTag

Module: gitlab | Returns: object -- API response.

gitlab.createTag

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMembers

listMembers

Module: gitlab | Returns: object -- API response.

gitlab.listMembers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addMember

addMember

Module: gitlab | Returns: object -- API response.

gitlab.addMember

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

Module: gitlab | Returns: object -- API response.

gitlab.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchProjects

searchProjects

Module: gitlab | Returns: object -- API response.

gitlab.searchProjects

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listEnvironments

listEnvironments

Module: gitlab | Returns: object -- API response.

gitlab.listEnvironments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Gitlab API error (${res.status}): ${t}	Check the error message for details
gitlab.setCredentials requires host, privateToken.	Check the error message for details
gitlab.deleteProject requires an ID.	Check the error message for details
gitlab.updateIssue requires an ID.	Check the error message for details
gitlab.updateMergeRequest requires an ID.	Check the error message for details
gitlab.mergeMergeRequest requires an ID.	Check the error message for details
gitlab.deleteBranch requires an ID.	Check the error message for details
gitlab.retryPipeline requires an ID.	Check the error message for details

@desc "List projects and validate result"
do
  set $result as gitlab.listProjects
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Projects

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "List projects and iterate results"
do
  set $result as gitlab.listProjects
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createProject

Create a new resource and capture the result.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "Create project"
do
  set $result as gitlab.createProject
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "Create project and update issue"
do
  set $created as gitlab.createProject
  # Update the created item
  gitlab.updateIssue
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "List projects and create project"
do
  set $existing as gitlab.listProjects
  if $existing == null
    gitlab.createProject
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step GitLab workflow

Chain multiple gitlab operations together.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "List projects, get project, and more"
do
  set $r_listProjects as gitlab.listProjects
  set $r_getProject as gitlab.getProject
  set $r_createProject as gitlab.createProject
  print "All operations complete"
enddo

6. Safe listProjects with validation

Check results before proceeding.

@desc "Setup authentication"
do
  gitlab.setCredentials $token
enddo

@desc "List projects and validate result"
do
  set $result as gitlab.listProjects
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• docker -- Docker module for complementary functionality
• git -- Git module for complementary functionality
• github -- GitHub module for complementary functionality
• vercel -- Vercel module for complementary functionality
• netlify -- Netlify module for complementary functionality