The CloudBees platform empowers users to efficiently build software by enabling them to integrate other DevOps tools, such as GitHub Actions (GHA), with the platform. GHA enables users to automate workflows within their GitHub repositories.
By setting up an integration between GHA and the platform, you can visualize your GHA workflows in the CloudBees platform, and take advantage of CloudBees' features, including security and analytics dashboards.
To configure the platform and GHA so that you can directly view GHA workflows and runs in the platform UI, perform the following:
-
Install the CloudBees GitHub App. To learn more, refer to GitHub integrations.
On occasion, new features in the CloudBees platform 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 Core permission? Key Actions
Commit statuses
Contents
Metadata
Events
Pull requests
Webhooks
-
Create a GHA workflow in the GitHub repository connected to the CloudBees platform. Alternatively, use an existing GHA workflow, but confirm that its repository is the one connected to the platform. If you do use an existing workflow, only runs executed after successful integration with the platform are displayed.
-
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 platform.
| Only GHA runs that have occurred from your GHA workflow after its successful integration with the CloudBees platform are displayed. |