Bitbucket

Bitbucket module for RobinPath.

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

Authentication

bitbucket.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 bitbucket module when you need to:

• listRepositories -- Use bitbucket.listRepositories to perform this operation
• getRepository -- Use bitbucket.getRepository to perform this operation
• createRepository -- Use bitbucket.createRepository to perform this operation
• deleteRepository -- Use bitbucket.deleteRepository to perform this operation
• listBranches -- Use bitbucket.listBranches to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure bitbucket credentials.	object
listRepositories	listRepositories	object
getRepository	getRepository	object
createRepository	createRepository	object
deleteRepository	deleteRepository	object
listBranches	listBranches	object
createBranch	createBranch	object
deleteBranch	deleteBranch	object
listPullRequests	listPullRequests	object
getPullRequest	getPullRequest	object
createPullRequest	createPullRequest	object
updatePullRequest	updatePullRequest	object
mergePullRequest	mergePullRequest	object
declinePullRequest	declinePullRequest	object
listCommits	listCommits	object
listPipelines	listPipelines	object
getPipeline	getPipeline	object
triggerPipeline	triggerPipeline	object
listIssues	listIssues	object
createIssue	createIssue	object
listWorkspaces	listWorkspaces	object
getWorkspace	getWorkspace	object
listWebhooks	listWebhooks	object
getUser	getUser	object
listDeployments	listDeployments	object

Functions

setCredentials

Configure bitbucket credentials.

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

bitbucket.setCredentials

Parameter	Type	Required	Description
username	string	Yes	username
appPassword	string	Yes	appPassword

---

listRepositories

listRepositories

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

bitbucket.listRepositories

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getRepository

getRepository

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

bitbucket.getRepository

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createRepository

createRepository

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

bitbucket.createRepository

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteRepository

deleteRepository

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

bitbucket.deleteRepository

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listBranches

listBranches

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

bitbucket.listBranches

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createBranch

createBranch

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

bitbucket.createBranch

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteBranch

deleteBranch

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

bitbucket.deleteBranch

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPullRequests

listPullRequests

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

bitbucket.listPullRequests

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getPullRequest

getPullRequest

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

bitbucket.getPullRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createPullRequest

createPullRequest

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

bitbucket.createPullRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updatePullRequest

updatePullRequest

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

bitbucket.updatePullRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

mergePullRequest

mergePullRequest

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

bitbucket.mergePullRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

declinePullRequest

declinePullRequest

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

bitbucket.declinePullRequest

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listCommits

listCommits

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

bitbucket.listCommits

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPipelines

listPipelines

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

bitbucket.listPipelines

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getPipeline

getPipeline

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

bitbucket.getPipeline

Parameter	Type	Required	Description
input	string	No	Input parameter

---

triggerPipeline

triggerPipeline

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

bitbucket.triggerPipeline

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listIssues

listIssues

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

bitbucket.listIssues

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createIssue

createIssue

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

bitbucket.createIssue

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listWorkspaces

listWorkspaces

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

bitbucket.listWorkspaces

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getWorkspace

getWorkspace

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

bitbucket.getWorkspace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listWebhooks

listWebhooks

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

bitbucket.listWebhooks

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

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

bitbucket.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDeployments

listDeployments

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

bitbucket.listDeployments

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Bitbucket API error (${res.status}): ${t}	Check the error message for details
bitbucket.setCredentials requires username, appPassword.	Check the error message for details
bitbucket.deleteRepository requires an ID.	Check the error message for details
bitbucket.deleteBranch requires an ID.	Check the error message for details
bitbucket.updatePullRequest requires an ID.	Check the error message for details
bitbucket.mergePullRequest requires an ID.	Check the error message for details
bitbucket.declinePullRequest requires an ID.	Check the error message for details
Bitbucket: "..." not configured. Call bitbucket.setCredentials first.	Check the error message for details

@desc "List repositories and validate result"
do
  set $result as bitbucket.listRepositories
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Repositories

Retrieve all items and loop through them.

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

@desc "List repositories and iterate results"
do
  set $result as bitbucket.listRepositories
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createRepository

Create a new resource and capture the result.

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

@desc "Create repository"
do
  set $result as bitbucket.createRepository
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

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

@desc "Create repository and update pull request"
do
  set $created as bitbucket.createRepository
  # Update the created item
  bitbucket.updatePullRequest
enddo

4. Check before creating

List existing items and only create if needed.

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

@desc "List repositories and create repository"
do
  set $existing as bitbucket.listRepositories
  if $existing == null
    bitbucket.createRepository
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Bitbucket workflow

Chain multiple bitbucket operations together.

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

@desc "List repositories, get repository, and more"
do
  set $r_listRepositories as bitbucket.listRepositories
  set $r_getRepository as bitbucket.getRepository
  set $r_createRepository as bitbucket.createRepository
  print "All operations complete"
enddo

6. Safe listRepositories with validation

Check results before proceeding.

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

@desc "List repositories and validate result"
do
  set $result as bitbucket.listRepositories
  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
• gitlab -- GitLab module for complementary functionality
• vercel -- Vercel module for complementary functionality