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 is for customers using a BluBracket Free Trial tenant.

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

2. 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 is for paid customers running on the BluBracket production servers

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

2. 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 is for paid customers using the on-premise GitHub Enterprise Server

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

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

   1. As part of the last step in that README.md file, send over the relevant configuration details. Wait for confirmation from us that our internal set up has been completed before proceeding.

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

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