Back to Top

Get Pull Request Info

Class Name com.midvision.rapiddeploy.plugins.scm.bitbucket.GetPullRequestInfoTask
Category Bitbucket

Get Pull Request Info Task.

Description

Make a REST request to a running BITBUCKET instance to retrieve information about pull request.

Usage

Set URL and credentials of your Bitbucket instance. Retrieved information will be stored in outputParameters: authorUserNameOutputParameter, destinationBranchOutputParameter, sourceBranchOutputParameter

Table of task Parameters

Name Type Default Value Optional Description
authorUserNameOutputParameter java.lang.String ${authorUserName} false Pull request author's name
bitbucketInstanceUrl java.lang.String https://api.bitbucket.org/2.0/ false The URL of the Bitbucket instance.
destinationBranchOutputParameter java.lang.String ${destinationBranch} false Pull request destination branch name
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
password java.lang.String   false Password for a specified username. We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
pullRequestID java.lang.String   false Id of pull request.
repoName java.lang.String   false Repository name.
repoUser java.lang.String   false The owner of repository.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceBranchOutputParameter java.lang.String ${sourceBranch} false Pull request source branch name
username java.lang.String   false Username that will be used to authenticate service call.

Back to Top

List Branches

Class Name com.midvision.rapiddeploy.plugins.scm.bitbucket.ListBranchesTask
Category Bitbucket

List Branches Task.

Description

Make a REST request to a running BITBUCKET instance to retrieve all branch names.

Usage

Set URL and credentials of your Bitbucket instance.

Table of task Parameters

Name Type Default Value Optional Description
bitbucketInstanceUrl java.lang.String https://api.bitbucket.org/2.0/ false The URL of the Bitbucket instance.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
password java.lang.String   false Password for a specified username. We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
repoName java.lang.String   false Repository name.
repoUser java.lang.String   false The owner of repository.
resultOutputParameter java.lang.String ${branches} false List of all branches under repository specified in repoName parameter
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username that will be used to authenticate service call.

Back to Top

List Open Pull Requests

Class Name com.midvision.rapiddeploy.plugins.scm.bitbucket.ListOpenPullRequestsTask
Category Bitbucket

List Open Pull Requests Task.

Description

Make a REST request to a running BITBUCKET instance to retrieve Open Pull Requests.

Usage

Set URL and credentials of your Bitbucket instance. Open pull requests will be retrieved in format [id:title] and separated with comas. So for example if there are two pull requests - your output parameter will be replaced with: 
                     			[1:pull request title1],[2:pull request title2]

Table of task Parameters

Name Type Default Value Optional Description
bitbucketInstanceUrl java.lang.String https://api.bitbucket.org/2.0/ false The URL of the Bitbucket instance.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
password java.lang.String   false Password for a specified username. We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
repoName java.lang.String   false Repository name.
repoUser java.lang.String   false The owner of repository.
resultOutputParameter java.lang.String ${openPullRequests} false List of open pull requests in format: [id1:title1], [id2:title2]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username that will be used to authenticate service call.

Back to Top

Update Pull Request

Class Name com.midvision.rapiddeploy.plugins.scm.bitbucket.UpdatePullRequestTask
Category Bitbucket

Update Pull Request Task.

Description

Make a REST request to a running BITBUCKET instance to update pull request. You can merge, approve or decline.

Table of task Parameters

Name Type Default Value Optional Description
action java.util.List merge false Choose from merge, approve, decline.
bitbucketInstanceUrl java.lang.String https://api.bitbucket.org/2.0/ false The URL of the Bitbucket instance.
failOnError java.lang.Boolean false false This task will not fail the deployment on error if set to false.
password java.lang.String   false Password for a specified username. We strongly recommend to use Data Dictionary value with type PASSWORD for safety reasons.
pullRequestID java.lang.String   false Id of pull request.
repoName java.lang.String   false Repository name.
repoUser java.lang.String   false The owner of repository.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   false Username that will be used to authenticate service call.