GitHub Checks Setup Instructions

Required permissions to install a GitHub App on an org – either an organization owner or someone with admin level permissions in a repository

GitHub Cloud Checks Setup For BluBracket Free Trial Edition

This version of GitHub Checks version is for customer using a BluBracket Free Trial tenant.

1. Navigate to BluBracket portal, import code server, track repos

2. Customer: Install the following app on the organization (should be done by someone who has permissions to install the app): https://github.com/apps/blubracket

3. Future PRs + commits to PRs should automatically run the scans via GitHub Checks

GitHub Cloud Checks Setup For BluBracket Enterprise Tenants

This version of GitHub Checks version is for paid customers running on the BluBracket production servers

1. Navigate to BluBracket portal, import code server, track repos

2. Customer: Install the following app on the organization (should be done by someone who has permissions to install the app): https://github.com/apps/blubracket-checks-app

3. Future PRs + commits to PRs should automatically run the scans via GitHub Checks

GitHub Enterprise Server Checks Setup

This version of GitHub Checks version is for paid customers using on-premise GitHub Enterprise

1. Navigate to BluBracket portal, import code server, track repos

2. Customer: Create the GitHub Enterprise Server Checks app (follow the instructions at https://github.com/BluBracket/blubracket-tools/tree/main/github-checks-app )

3. Blu Support User: Send the app ID, client ID, client secret, webhook secret to the dynamic config handler. Follow the following curl request template:

   curl -H "Authorization: Bearer <token>" -X "POST" https://<external_route>/api/config --data '{"key": "BLU_GITHUB_APPS_ON_ENTERPRISE", "value": "[{\"app_id\": \"<app_id>\", \"webhook_secret\": \"<webhook_secret>\", \"client_secret\": \"<client_secret>\", \"client_id\": \"<client_id>\", \"enterprise_domain\": \"<enterprise_domain>\"}]"}'
   

   1. WARNING: Posting to this endpoint will cause you to overwrite existing GitHub Enterprise Server Checks apps. The recommendation for creating a second app is to write into the database.

4. Customer: Install the app created from step 2 on the organization (should be done by someone who has permissions to install the app)

5. Future PRs + commits to PRs should automatically run the scans via GitHub Checks