By enabling the GitHub Actions connector, you can analyze GitHub Action workflows and map them to your repositories and services. Please visit our schema explorer to see what data DX imports.
Before proceeding, please make sure that you have first enabled the GitHub connector by following the steps documented here. Each GitHub-related connection in DX should utilize a separate GitHub App in order to parallelize API requests for data ingestion.
Prerequisites
To connect GitHub to DX, you need:
a GitHub account that is an Organization owner or Enterprise owner
if your GitHub instance is behind a firewall or has IP restrictions, you need to allowlist DX IP addresses
Setup instructions
Follow the steps below to connect GitHub to DX.
Step 1
If you are using GitHub Enterprise Cloud, browse to the URL below with
ENTERPRISE_NAME
replaced:https://github.com/enterprises/ENTERPRISE_NAME/settings/apps/new?public=false&url=https://getdx.com&actions=read&metadata=read&pull_requests=read&webhook_active=false
If you are using GitHub Enterprise Server or GitHub Team Edition, browse to the URL below with
ORGANIZATION_NAME
replaced:https://github.com/organizations/ORGANIZATION_NAME/settings/apps/new?public=false&url=https://getdx.com&actions=read&metadata=read&pull_requests=read&webhook_active=false
This will pre-populate settings and permissions, but you'll need to manually enter a name for your GitHub App. We recommend naming your app "[COMPANYNAME] DX - GitHub Actions" to avoid naming collisions with other GitHub Apps.
Below are the full set of required GitHub App permissions:
Repository permissions:
Read-only access to Metadata
Read-only access to Pull requests
Read-only access to Actions
Step 2
Scroll to the bottom of the page and click the "Create GitHub App" button.
Step 3
The App ID will be shown at the top of the subsequent screen. Copy this ID down so it can be entered into DX later.
Step 4
On the same screen, scroll down to the "Private keys" heading and click "Generate a private key" which will initiate a download of a PEM file. Copy the contents of this file to be entered into DX later.
Step 5
Click on the "Install App" link in the sidebar navigation and then click "Install" beside your GitHub organization.
To get your initial data imported as quickly as possible, please select only your most important repositories initially, then come back and select more later.
By default, public repositories are not imported. If you would like public repositories to be imported, please contact DX Support.
Step 6
Navigate to the connector setup form in DX.
Enter the credentials you have generated in the previous steps—refer to the information below for errors and troubleshooting.
Updating permissions
To update your GitHub App permissions, go to your organization's Developer Settings and click on GitHub Apps.
From there, click on Edit for the GitHub App you are using for DX and then navigate to the Permissions & events tab. After making changes, scroll down to the bottom of the page and click Save changes.
To apply these changes, go to the Install App tab, click on the gear icon for each organization listed, and then click and accept the Review request as shown in the images below.
API Reference
The table below lists the specific API endpoints that are used by DX.
Endpoint | Documentation | Permissions Needed |
/repos/{repo}/actions/runs | actions:read | |
/repos/{repo}/actions/runs/{run_id} | actions:read | |
/repos/{repo}/actions/runs/{run_id}/jobs | actions:read | |
/repos/{repo}/actions/runs/{source_workflow_id}/timing | actions:read |
Errors
The table below lists potential error codes when adding a connection in DX.
Error | Description |
| Your API credentials entered are not valid. |
| Your GitHub App installation does not have the permissions required by DX. |
| Your GitHub App installation cannot access any repositories. |
| The key passed in is not an RSA private key. |