Skip to main content
Setting up CI Integrations
GitHub CI: PR Gating via Aikido Dashboard

GitHub CI: PR Gating via Aikido Dashboard

Introduction

You can easily configure GitHub PR Gating via the Aikido interface. This doc focusses on managing configurations in bulk - multiple repos at the same time - without code.

Note. If you want to manage your GitHub Configurations in code (and per repo), please check out our other article.

Use Cases

  • Bulk Repository Management: Easily specify and manage configurations for multiple repositories at once through the Aikido interface.

  • Zero Code Integration: Install the Aikido app on GitHub to manage checks without embedding any code, simplifying the setup process.

  • Cost Efficiency: By managing GitHub Checks through Aikido, avoid using CI minutes on GitHub, leading to significant cost savings.

Setting up GitHub CI

Step 1. Go to the Integrations Page and select GitHub in the CI gating section.

Step 2. Select PR Gating Configuration Via Aikido Dashboard in the modal that pops up. This will open up a new tab with GitHub to install the PR Checks App.

Step 3. Install the Aikido PR Checks app in GitHub. Make sure that you select the GitHub organisation that is currently being used in your workspace. Choose which repos that Aikido is allowed to access. We recommend giving access to all repos so these can easily be managed from within Aikido.

Step 4. Aikido redirects you to the GitHub CI page with an overview of your repos. You can start configuring your repos. We recommend starting out with 1 repo to make sure everything works well.

Step 5. Select repos in bulk and click Configure Scans button in the top right.

Step 6.This will trigger the modal to choose the severity level for failure and the scans you want to execute.

If you've added new repositories after the initial setup, you'll need to configure those repos as well.

Adding Exceptions for specific repos

You might want to have 1 specific repo where the configuration slightly differs. You can easily add exceptions by clicking the triple dots on a repo item or just select 1 or more items and go through the Configure Scans process again.

Automatic Configuration for Newly Added Repos

It is possible to auto-enable any new repos with a default configuration. This is helpful when new repos are frequently added to your codebase, and you do not want to configure these new repos each time manually.

Prerequisite

  • Make sure that on the repository settings page, the option to automatically activate new repos has been activated. This can be done by clicking the 'Configure' button on that page.

Steps

Step 1. On the GitHub CI page, Click 'Settings'

Step 2. Enable the switch to automatically activate scan configuration for new repos

Step 3. Set the configuration that should be applied to all new repos