How to add Bitbucket CLI task in a Bamboo job with Run CLI Actions in Bamboo

This article explains how to add Bitbucket CLI task in a Bamboo job with Bamboo Command Line Interface (CLI).

Instructions

Use the addTask action to create Bitbucket CLI action tasks in the Bamboo job. Refer to the following sample command:

--action addTask --plan DEMO-PLAN  --job JOB1  --description "Build Report" --taskKey org.swift.bamboo.acli:bitbucket --field scriptLocation=INLINE --field scriptBody="--action mergePullRequest --project "DEMO" --repository "cli-repo" --pullRequest "pr2" --server "Bitbucket_Server" --user "Bitbucket_Username" --password "Bitbucket_Password" "

In the above action:

  • --plan value refers to a Bamboo plan key.
  • --job value refers to the Bamboo job key.
  • --taskKey value refers to the Bitbucket task type.
  • --description value refers to the task description.
  • --field parameter refers to a specific Bitbucket CLI task configuration.
    • --field  scriptLocation=INLINE refers to the inline action type.
    • --field scriptBody="--action mergePullRequest --project "DEMO" --repository "cli-repo" --pullRequest "pr2" --server "Bitbucket_Server" --user "Bitbucket_Username" --password "Bitbucket_Password" " refers to the Bitbucket CLI action to be added as a task in the Bamboo job.
  • Additionally, --disable parameter can be used to disable the task, and --final parameter can be used to script the task as a final task.
  • Make sure that Run CLI Actions in Bamboo app installed in Bamboo.
  • It is recommended to test this scenario in a non-production environment or run the action with --simulate parameter to verify the behavior before deploying.