How to add Confluence CLI task in Bamboo job using Bamboo Command Line Interface (CLI)

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

Instructions

Use the addTask action to create inline Confluence CLI task in the Bamboo job. Refer to the sample command below:

--action addTask --plan DEMO-PLAN  --job JOB1  --description "Create a Confluence Page" --taskKey org.swift.bamboo.acli:confluence --field scriptLocation=INLINE --field scriptBody="--action addPage --space DEMO --parent "@home" --title \"Build Result\"  --server "Confluence_Server" --user "Confluence_Username" --password "Confluence_Password" "

In this action:

  • --plan value refers to a Bamboo plan key.
  • --job value refers to the Bamboo job key.
  • --taskKey value refers to the Bamboo task type.
  • --description value refers to the task description.
  • --field parameter refers to specific Confluence CLI task configuration.
    • --field  scriptLocation=INLINE refers to the inline action type.
    • --field scriptBody="--action addPage --space DEMO --parent "@home" --title \"Build Result\" --server "Confluence_Server" --user "Confluence_Username" --password "Confluence_Password" "  refers to Confluence CLI action.
  • Additionally, the --disable parameter can be used to disable the task and --final to script 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 the --simulate parameter to verify the behavior before deploying.