Introduction
Understanding organizationsUnderstanding componentsManage organizationsManage componentsManage component Jira integrations
Set up your first organizationUnderstanding users and teamsUnderstanding role-based access controlManage usersManage teamsConfigure role-based access controlRBAC permissions reference
Understanding authentication in CloudBees UnifySet up multifactor authenticationConfigure SAML single sign-onConfigure OIDC authenticationConfigure network security policiesNetwork security reference
Understanding platform configurationUnderstanding environmentsManage properties and secretsManage environmentsTrack environment inventoryConfigure containersSet up preconfigured actionsConfigure notifications
Accessibility policy referenceShared responsibility model referenceSubscription and services agreementSupport policiesSupported browsers and external tools
Introduction
Understanding feature managementUnderstanding Configuration as CodeGet started with feature managementCreate and manage feature flagsConfigure feature flag targetingOrganize feature flagsImplement feature flag governanceConfiguration as Code reference
Understanding flag impressions and activity statusUnderstanding flag healthUnderstanding code referencesReview and clean up feature flagsSet up code references
Understanding Jira integration for feature flagsSet up the Jira integrationLink Jira tickets to feature flags
Understanding multiple SDK keysBuild your first mobile app with feature flagsBuild your first feature-flagged web applicationBuild your first feature-flagged backend serviceInstall client-side SDKsInstall server-side SDKsConfigure multiple SDK keysMobile SDK referenceWeb SDK referenceBackend SDK referenceClient SDK referenceFlag implementation reference
Introduction
Understanding CI workflowsCreate a build workflowCreate and manage workflowsCreate reusable workflowsTest and validate containers in workflowsCheck out source codeTrigger workflows remotelyWorkflow syntax referenceJobs syntax referenceSteps syntax referenceServices syntax reference
Monitor workflow runsView test results in runsView evidence in runsView deployments in runsManage workflow artifactsPublish test resultsPublish evidence itemsGenerate a software bill of materialsManage ServiceNow change requests
Configure workflow credentialsConfigure AWS credentialsConfigure container registry credentialsConfigure Git credentialsIntegrate external secret providers
Understanding GitHub Actions integrationSet up GitHub Actions integrationDisplay GitHub Actions workflows and runsRegister GHA build artifactsPublish GHA deployed artifactsPublish GHA test resultsPublish GHA evidence itemsTrigger CloudBees workflows from GitHub ActionsScan with GitHub Actions
Understanding CloudBees CI and Jenkins® integrationConnect CI and Jenkins controllersMonitor CI and Jenkins buildsRegister CI build artifactsRegister CI deployed artifactsPublish CI test resultsConfigure CI security scanningCI and Jenkins integration reference
Build and publish container imagesUnderstanding external CI/CD integrationsRun external CI/CD jobsExternal CI/CD action reference
Introduction
Understanding release orchestrationManage applicationsCreate deployer workflowsCreate staged workflowsCreate and manage releasesOrchestrate multi-workflow releasesRelease management reference
Understanding artifact managementRegister and track artifactsStore and retrieve artifactsPromote artifactsGenerate a software bill of materialsArtifact management reference
Deploy with HelmDeploy to KubernetesContainer deployment reference
Deploy to AWSAWS deployment reference
Deploy with enterprise platformsExecute remote deployment commandsEnterprise deployment reference
Verify deployments with New RelicDeployment verification reference

External CI/CD action reference

5 minute read

Input and output reference for all CloudBees actions that trigger jobs and pipelines on external CI/CD platforms. For usage guidance, refer to Run external CI/CD jobs.

AWS CodePipeline

Action: https://github.com/cloudbees-io/aws-codepipeline-invoke-actions@v1

Table 1. Input details
Input name Data type Required? Description

pipeline-name

String

Yes

The AWS CodePipeline pipeline name.

parameters

JSON

No

AWS CodePipeline parameters, formatted as JSON data in key/value pairs.

Bamboo

Action: https://github.com/cloudbees-io/bamboo-run-project@v2

Table 2. Input details
Input name Data type Required? Description

url

String

Yes

The Bamboo server URL.

username

String

Yes

The Bamboo username.

password

String

Yes

The Bamboo password.

project-name

String

No

The Bamboo project name.

plan-name

String

No

The Bamboo plan name.

invoke-type

String

Yes

The action type. Supported types are build, release, and deploy.

branch-name

String

No

The Bamboo branch name.

deploy-project-name

String

Required for release and deploy action types.

The Bamboo deploy project name.

release-name

String

Required for release and deploy action types.

The Bamboo release name.

env-name

String

Required for deploy action type.

The Bamboo environment name.

test-type

String

No

Specifies the test type for generating a job test report. Supported test types are JUnit (junit) and TestNG (testng).

test-result-location

String

No

Specifies the test report file location. Accepts pattern matching, such as my-dir/*/my-file.

Bitbucket Pipelines

Action: https://github.com/cloudbees-io/bitbucket-run-pipeline@v1

Table 3. Input details
Input name Data type Required? Description

url

String

Yes

The Bitbucket URL.

token

String

Yes

The Bitbucket token.

workspace-name

String

Yes

The Bitbucket workspace name.

repository-name

String

Yes

The Bitbucket repository name.

branch-name

String

Yes

The Bitbucket branch name.

CloudBees CI

Action: https://github.com/cloudbees-io/cbci-run-job@v2

Table 4. Input details
Input name Data type Required? Description

url

String

Yes

The CloudBees CI server URL.

username

String

Yes

The CloudBees CI username.

token

String

Yes

The CloudBees CI token.

job-name

String

Yes

The CloudBees CI job name.

test-type

String

No

Specifies the test type for generating a job test report. Supported test types are JUnit (junit) and TestNG (testng).

test-result-location

String

No

Specifies the test report file location. Accepts pattern matching, such as my-dir/*/my-file.[1]

parameters

JSON

No

Any additional CloudBees CI parameters, formatted as JSON data in key/value pairs.

[1] You must specify the test-result-location to publish your test results in CloudBees Unify Test insights dashboard.

Table 5. Output details
Output name Data type Description

cbci_output

String

A JSON string containing the output key/values exposed by the invoked CloudBees CI pipeline.[2]

[2] Parse each output parameter in the following format:

fromJSON(steps.<STEP-ID>.outputs.cbci_output).<OUTPUT_PARAMETER>

Replace <STEP-ID> with your step ID and <OUTPUT_PARAMETER> with your parameter.

CircleCI

Action: https://github.com/cloudbees-io/circleci-run-workflow@v2

Table 6. Input details
Input name Data type Required? Description

url

String

No

The CircleCI server URL. If not specified, uses https://circleci.com/.

token

String

Yes

The CircleCI token.

vcs-name

String

Yes

The source code management system used. Supported values are GitHub (gh) and Bitbucket (bb).

org-name

String

Yes

The CircleCI organization name.

repo-name

String

Yes

The CircleCI repository name.

branch-name

String

Yes

The CircleCI branch name.

workflow-name

String

Yes

The CircleCI workflow name.

test-type

String

No

Specifies the test type for generating a job test report. Supported test types are JUnit (junit) and TestNG (testng).

test-result-location

String

No

Specifies the test report file location. Accepts pattern matching, such as my-dir/*/my-file.

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.

GitHub Actions

Action: https://github.com/cloudbees-io/ghactions-run-workflow@v2

  • The target GitHub Actions workflow must specify the workflow_dispatch trigger to be invoked via REST API. Refer to GitHub documentation on manually running a workflow for details.

  • The GitHub token must have Actions: read/write permissions for the repository that owns the workflow.
Table 7. Input details
Input name Data type Required? Description

url

String

No

The GitHub server URL. If not specified, uses https://api.github.com.

token

String

Yes

The GitHub token.

org-name

String

Yes

The GitHub organization name.

repo-name

String

Yes

The GitHub Actions repository name.

branch-name

String

Yes

The GitHub Actions branch name.

workflow-name

String

Yes

The GitHub Actions workflow name.

This is the name attribute defined within the target GitHub Actions YAML file.

test-type

String

No

Specifies the test type for generating a job test report. Supported test types are JUnit (junit), TestNG (testng), MSTest (mstest), ProdPerfect (prodperfect), Jmeter (jmeter), Selenium (selenium), Tosca (tosca), Go (go), Jest (jtest), and Playwright (playwright).

test-result-location

String

No

Specifies the test report file location. Accepts pattern matching, such as my-dir/*/my-file.

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.
Parameters with spaces in their values can cause errors.

GitLab

Action: https://github.com/cloudbees-io/gitlab-run-pipeline@v1

Table 8. Input details
Input name Data type Required? Description

url

String

No

The GitLab server URL. If not specified, uses https://gitlab.com.

access-token

String

Yes

The GitLab API access token.

trigger-token

String

Yes

The GitLab pipeline API trigger token.

namespace

String

Yes

The GitLab namespace corresponding to the project.

project-name

String

Yes

The GitLab pipeline project name.

branch-name

String

Yes

The GitLab branch name.

parameters

JSON

No

GitLab pipeline parameters, formatted as JSON data in key/value pairs.

Harness

Action: https://github.com/cloudbees-io/harness-run-pipeline@v1

Table 9. Input details
Input name Data type Required? Description

url

String

No

The Harness server URL. If not specified, uses https://app.harness.io.

token

String

Yes

The Harness API token.

org-name

String

Yes

The Harness pipeline organization name.

project-name

String

Yes

The Harness pipeline project name.

pipeline-name

String

Yes

The Harness pipeline name.

Jenkins

Action: https://github.com/cloudbees-io/jenkins-run-job@v2

Table 10. Input details
Input name Data type Required? Description

url

String

Yes

The Jenkins server URL.

username

String

Yes

The Jenkins username.

token

String

Yes

The Jenkins token.

job-name

String

Yes

The Jenkins job name.

test-type

String

No

Specifies the test type for generating a job test report. Supported test types are JUnit (junit), TestNG (testng), MSTest (mstest), ProdPerfect (prodperfect), Jmeter (jmeter), Selenium (selenium), Tosca (tosca), Go (go), Jest (jtest), and Playwright (playwright).

test-result-location

String

No

Specifies the test report file location. Accepts pattern matching, such as my-dir/*/my-file.[1]

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.

[1] You must specify the test-result-location to publish your test results in CloudBees Unify Test insights dashboard.

Table 11. Output details
Output name Data type Description

jenkins_output

JSON string

A JSON string containing the output key/values exposed by the invoked Jenkins pipeline.[2]

[2] Parse each output parameter in the following format:

fromJSON(steps.<STEP-ID>.outputs.jenkins_output).<OUTPUT_PARAMETER>

Replace <STEP-ID> with your step ID and <OUTPUT_PARAMETER> with your parameter.

JFrog Pipelines

Action: https://github.com/cloudbees-io/jfrog-run-pipeline@v1

Table 12. Input details
Input name Data type Required? Description

url

String

Yes

The JFrog Pipelines server URL.

token

String

Yes

The JFrog Pipelines token.

pipeline-name

String

Yes

The JFrog Pipelines pipeline name.

project-name

String

No

The JFrog Pipelines project name.

branch-name

String

No

The JFrog Pipelines branch name.

environment-variables

JSON

No

JFrog environment variables, formatted as JSON data in key/value pairs.

TeamCity

Action: https://github.com/cloudbees-io/teamcity-run-project@v1

Table 13. Input details
Input name Data type Required? Description

host

String

Yes

The TeamCity host URL.

token

String

Required if username and password are not specified.

The TeamCity token.

username

String

Required if token is not specified.

The TeamCity username.

password

String

Required if token is not specified.

The TeamCity password.

project-name

String

Yes

The TeamCity project name.

build-type-name

String

Required if the project has multiple builds.

The TeamCity plan name.

branch-name

String

No

The TeamCity branch name.

parameters

JSON

No

Any additional parameters, formatted as JSON data in key/value pairs.

Related pages

Run external CI/CD jobs