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

Trigger CloudBees workflows from GitHub Actions

2 minute read

Use the run-cloudbees-workflow GitHub Action in a GHA workflow to trigger a CloudBees Unify workflow. This action is available on the GitHub Marketplace.

Inputs

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

cloudbees-pat

String

Yes

The CloudBees Unify personal access token.

workflow-file-name

String

Yes

The filename of the CloudBees Unify workflow YAML file to be run.

cloudbees-url

String

No

The CloudBees Unify URL. The default value is https://api.cloudbees.io.

component-id

String

No

The identifier of the CloudBees Unify component where the workflow to be run resides. If the caller GHA workflow has been onboarded to CloudBees Unify, the default is the component ID of where the caller GHA workflow is located.[1]

branch-name

String

No

The repository code branch of the CloudBees Unify workflow to be run. The default is the same branch as the triggering GHA workflow.

workflow-inputs

JSON

No

Input parameters required to run the CloudBees Unify workflow, formatted as JSON data in key/value pairs.

[1] To find the multi-hexadecimal component UUID:

  1. Navigate to the component in CloudBees Unify.

  2. Locate the ID value in the URL after componentId=.

Output

Table 2. Output details
Output name Data type Description

cbp-run-url

String

The CloudBees Unify URL of the triggered CloudBees workflow run.

Usage examples

The following is a basic example of using the action:

steps:
      - name: Run CloudBees workflow
        uses: cloudbees-io-gha/run-cloudbees-workflow@v1
        with:
          cloudbees-pat: ${{ secrets.MY_PAT }}
          workflow-file-name: "workflow.yaml"
▼

The following example specifies the component ID and branch name:

steps:
      - name: Run CloudBees workflow main branch
        uses: cloudbees-io-gha/run-cloudbees-workflow@v1
        with:
          cloudbees-pat: ${{ secrets.MY_PAT }}
          workflow-file-name: "workflow.yaml"
          component-id: "1234abcd-56ef-78gh-90ij-123456klmnop"
          branch-name: "main"
▼

The following example specifies input parameters:

steps:
      - name: Run CloudBees workflow main branch
        uses: cloudbees-io-gha/run-cloudbees-workflow@v1
        with:
          cloudbees-pat: ${{ secrets.MY_PAT }}
          workflow-file-name: "workflow.yaml"
          workflow-inputs: '{"workflowInput1": "test1","workflowInput2": "test2"}'
▼

Related pages

Publish GHA evidence items
Scan with GitHub Actions