How to add a trigger to Bamboo plan using Bamboo Command Line Interface (CLI)

Owned by Manisha Kharga
Last updated: Apr 27, 2020
1 min read

This article explains how to add a trigger to a Bamboo plan using Bamboo Command Line Interface (CLI) app.

Instructions

Use addTrigger action to add a trigger to the plan. Triggering in Bamboo allows plan builds to be started automatically.

  • Execute this action for the trigger type, Polling. Bamboo will 'poll' the selected source code repositories for code changes using a schedule.

    --action addTrigger --plan "MKTES-TP" --type "Polling" --description "polling trigger" --repository "test_training_mk" --schedule "3600"

  • Execute this action for the trigger type, Scheduled. Bamboo will trigger scheduled builds of this plan based on a cron expression.

    --action addTrigger --plan "MKTES-TP" --type "Scheduled" --description "scheduled trigger" --schedule "1 0 0 ? * *"

The parameters used in the actions are:

--plan value refers to Bamboo plan key.
--type value refers to the triggering options.
--repository value refers to the repository name.
--schedule value refers to the schedule configuration.

  • It is recommended to test the commands in a non-production environment, or, run the action with --simulate parameter to verify the behavior before deploying.
  • For more details, refer to Cron-based scheduling.