Run a Pipeline on a remote CloudBees CD/RO instance

Description

This is one of several GitHub Actions provided on an "as-is" basis by CloudBees that enable users to write GitHub Action Workflows that send work to an external CloudBees CD/RO instance. This Action enables workflows to run an existing Pipeline on a remote CloudBees CD/RO instance.

Intended audience

For teams utilizing GitHub Actions for build and continuous integration, the CloudBees CD/RO Actions provide a mechanism for releasing software in a secure, governed and auditable manner with deep visibility, as is required in regulated industries, for example. Platform or shared services teams can build reusable content in the CloudBees CD/RO platform that conforms to company standards and removes the burden of release automation from the application teams.

Prerequisites

CloudBees CD/RO is an enterprise "on-premise" product that automates software delivery processes, including production deployments and releases. To use utilize this GitHub Action, it is necessary to have access to a CloudBees CD/RO instance, in particular,

• A CloudBees CD/RO instance that GitHub Actions can access through REST calls (TCP port 443)
• A valid API token for the CloudBees CD/RO instance. A token can be generated from the Access Token link on the user profile page of the CloudBees CD/RO user interface; see Manage access tokens via the UI documentation for details. These values should be stored as GitHub Action secrets to be referenced securely in a GitHub Actions workflow.

Usage

The CloudBees CD/RO GitHub Actions are called from steps in a GitHub Actions workflow. The following workflow extract illustrates how to run an existing Pipeline on a remote CloudBees CD/RO instance, including actual parameters.

steps:
  - name: Run Pipeline Action
    uses: cloudbees-github-actions/run-pipeline@v1
    env:
      CDRO_URL: ${{ secrets.CDRO_URL }}
      CDRO_TOKEN: ${{ secrets.CDRO_TOKEN }}
    with:
      projectName: My project
      pipelineName: My pipeline
      actualParameter: |
        param1: param1 value
        param2: 1.0

Inputs

Name	Description	Required
projectName	Project name of the pipeline	yes
pipelineName	Pipeline name	yes
actualParameter	Parameters as list of key-value pairs	no
ignore-unverified-cert	Ignore unverified SSL certificate	no

Outputs

Name	Description
response	The JSON data structure emited by the API call. This data can be parsed to retrieve individual values from the response, for example, ${{ fromJson(steps.start-release.outputs.response).flowRuntime.flowRuntimeId }} where start-release is the name of a previous step and .flowRuntime.flowRuntimeId is the selector for the release pipeline runtime ID.

Secrets and Variables

The following GitHub secrets are needed to run the Action. These can be set in the Secrets and variable section of the workflow repository Settings tab.

Name	Description	Required
CDRO_URL	CloudBees CD/RO server URL, e.g., https://my-cdro.net or https://74.125.134.147	yes
CDRO_TOKEN	CloudBees CD/RO API Access token	yes

Examples

Create and run a Pipeline

1. Set up secrets in the repository settings for Actions. In the GitHub repository, select the Settings tab, Secrets, Variables, and Actions. Use the New Repository button to create the CDRO_URL and CDRO_TOKEN secrets.
2. Create a DSL file in the root directory of your repository, for example, simple-pipeline-dsl.groovy:

project "Default",{
	pipeline "My simple pipeline",{
		formalParameter "Input1"
		formalParameter "Input2"
		formalParameter "Input3", type: "textarea"
		stage "Stage 1"
	}
}

3. Create a new workflow file in the .github/workflows directory, for example, simple-pipeline.yml:

name: Create and run pipeline

on:
  workflow_dispatch:

jobs:
  create-and-run-pipeline:
    runs-on: ubuntu-latest
    env:
      CDRO_URL: ${{ secrets.CDRO_URL }}
      CDRO_TOKEN: ${{ secrets.CDRO_TOKEN }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Create pipeline
        uses: cloudbees-github-actions/eval-dsl@v1
        with:
          dsl-file: simple-pipeline-dsl.groovy

      - name: Run pipeline
        uses: cloudbees-github-actions/run-pipeline@v1
        with:
          projectName: Default
          pipelineName: My simple pipeline
          actualParameter: |
            Input1: xyz
            Input2: abc
            Input3: "line1\nline2"

4. Go to the GitHub Actions tab and run the workflow Create and run pipeline

Sample build and release repository

The CloudBees CD/RO GitHub Actions Demonstration Repository illustrates how to implement a build and release workflow with the CloudBees CD/RO GitHub Actions.

License

The scripts and documentation in this project are released under the MIT License.

Documentation

For more details about the CloudBees CD/RO product, view the online documentation.