Circle CI Integration Pack

Pack for integration of Circle CI into StackStorm. The pack includes the functionality to perform actions on Circle CI through StackStorm.

Actions

Get build number - get_build_number

The action to get the build number given a VCS revision and a project name.

Usage:

st2 run circle_ci.get_build_number project=<project> vcs_type=github username=<username> vcs_revision=<sha>

Wait until build finishes - wait_until_build_finishes

The action can be used to wait until a build finishes for a build number. An optional wait_timeout can be specified to specify the maximum wait time after which the action fails if the build didn't complete.

Usage:

st2 run circle_ci.wait_until_build_finishes project=<project> vcs_type=github username=<username> build_num=<build> wait_timeout=<timeout>

Get build info - get_build_info

The action to get the information of a build given a project name and build number.

Usage:

st2 run circle_ci.get_build_info project=<project> vcs_type=github username=<username> build_num=<build_num>

Run build - run_build

The action to run a build given a project name and branch. Default branch name is master.

NOTE: For Circle CI 2.0 workflows, you should use run_project_build action which will trigger a build for all the workflows in a specific project.

Usage:

st2 run circle_ci.run_build project=<project> vcs_type=github username=<username> branch=<branch_name>
OR
st2 run circle_ci.run_build project=<project> vcs_type=github username=<username> tag=<tag_name>
OR
st2 run circle_ci.run_build project=<project> vcs_type=github username=<username> vcs_revision=<sha>

Retry build - retry_build

The action to retry a build given a project name and build number.

Usage:

st2 run circle_ci.retry_build project=<project> vcs_type=github username=<username> build_num=<build_num>

Cancel build - cancel_build

The action to cancel a build given a project name and build number.

Usage:

st2 run circle_ci.cancel_build project=<project> vcs_type=github username=<username> build_num=<build_num>

Configuration

Replace your Circle CI token in the config file and you are all set to use the actions.

token: Your Circle CI API access token

Note : When modifying the configuration in /opt/stackstorm/configs/ please remember to tell StackStorm to load these new values by running st2ctl reload --register-configs