GitHub Actions and the CloudBees Unify: Getting started

2 minute read

The CloudBees Unify empowers users to efficiently build software by enabling them to integrate other DevOps tools, such as GitHub Actions (GHA), with CloudBees Unify. GHA enables users to automate workflows within their GitHub repositories.

By setting up an integration between GHA and CloudBees Unify, you can visualize your GHA workflows in the CloudBees Unify, and take advantage of CloudBees' features, including security and analytics dashboards.

To configure CloudBees Unify and GHA so that you can directly view GHA workflows and runs in CloudBees Unify UI, perform the following:

  1. Install the CloudBees GitHub App. To learn more, refer to GitHub integrations.

    On occasion, new features in the CloudBees Unify may require updates to permissions in the GitHub App for full functionality. Verify that the following permissions are set in the CloudBees GitHub App installation:

    Table 1. Installed GitHub App required permissions
    Read access Write access Key

    Actions

    Commit statuses

    Contents

    Metadata

    Events

    Pull requests

    Webhooks

  2. Create a GHA workflow in the GitHub repository connected to the CloudBees Unify. Alternatively, use an existing GHA workflow, but confirm that its repository is the one connected to CloudBees Unify. If you do use an existing workflow, only runs executed after successful integration with CloudBees Unify are displayed.

    • Do not include a forward slash with spaces on both sides ( / ) in the job name, for example, build / reusable-job / test. GHA reports job statuses for reusable workflows using slashes with spaces on both sides in job names to represent hierarchy. Currently CloudBees Unify interprets any forward slash with spaces on both sides to indicate a GHA reusable workflow job, and so it does not correctly display Run details for that job.

    • Do not use the name attribute in the jobs definition. If you do, then any data associated with the job (for example, evidence reported via cloudbees-io-gha/publish-evidence-item) will not show up in the CloudBees Unify run.

  3. Create a component with the connected repository that contains your GHA workflow.

    You are now ready to display GHA workflows and runs in the CloudBees Unify.

    Only GHA runs that have occurred from your GHA workflow after its successful integration with the CloudBees Unify are displayed.