> For the complete documentation index, see [llms.txt](https://help.aikido.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aikido.dev/pr-and-release-gating/github-ci-pr-gating-via-aikido-dashboard.md).

# GitHub PR Gating

You can easily configure GitHub PR Gating via the Aikido interface. This functionality lets you block **newly introduced** issues for a threshold you decide and see which existing issues a pull request solves. These checks run **everytime** changes are committed to the feature branch. This doc focusses on managing configurations in bulk - multiple repos at the same time - without code.

### Use Cases <a href="#use-cases" id="use-cases"></a>

* **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 <a href="#setting-up-github-ci" id="setting-up-github-ci"></a>

**Step 1.** Go to the [Integrations Page](https://app.aikido.dev/settings/integrations) and select GitHub in the CI gating section.

<div data-with-frame="true"><img src="/files/VOGnNuk3VSO8JTWGF2vM" alt="Connect CI tools (GitHub, GitLab, Bitbucket, Azure) to block risky code merges." width="563"></div>

**Step 2 (optional).** 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. **Note: this modal will only popup if you have already used GitHub Actions via code**.

<div data-with-frame="true"><img src="/files/uy783vYaM74wQa48NzdM" alt="Select a PR gating method for GitHub: Aikido dashboard or GitHub Actions in code." width="563"></div>

**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.

<div data-with-frame="true"><img src="/files/Rhs5D4vqS9RoigK7dbKP" alt="Aikido PR Checks installation prompt with logo and installation location query." width="563"></div>

**Step 4.** Aikido redirects you to the [GitHub CI page](https://app.aikido.dev/settings/integrations/github/checks) 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.

<div data-with-frame="true"><figure><img src="/files/jvZqhdApuXuKtd58QgS2" alt=""><figcaption></figcaption></figure></div>

**Step 5. Select repos in bulk** and click **Setup PR Scans** in the floating bar on the bottom

<div data-with-frame="true"><figure><img src="/files/D059w3tYqd6i8s0ockli" alt=""><figcaption></figcaption></figure></div>

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

<div data-with-frame="true"><img src="/files/Gqpb3ntPL4zOrZOlrIdd" alt="Security scanning configuration settings for the &#x22;about-github&#x22; repository." width="563"></div>

{% hint style="info" %}
If you've added new repositories after the initial setup, you'll need to configure those repos as well.

To apply a default configuration automatically, see [Default PR/MR gating configuration for new repositories](/pr-and-release-gating/aikido-ci-gating-functionality/default-pr-mr-gating-configuration-for-new-repositories.md).
{% endhint %}

### Ignore issues directly from PR comments <a href="#ignore-issues-directly-from-pr-comments" id="ignore-issues-directly-from-pr-comments"></a>

When Aikido posts an inline PR comment for a finding, you can ignore that issue directly from GitHub by replying to the comment with:

`@AikidoSec ignore: [your reason to ignore]`

Example:

`@AikidoSec ignore: This secret is used for tests only.`

This performs the same action as manually ignoring the issue in the Aikido platform:

* The issue is marked as ignored in Aikido.
* The ignore reason is stored.
* PR gating can turn green once all blocking issues are resolved or ignored.

### Make failed PR checks block merges <a href="#make-failed-pr-checks-block-merges" id="make-failed-pr-checks-block-merges"></a>

Aikido can fail the PR check, but GitHub decides whether that failing check blocks a merge. Configure branch protection with required status checks:

* [GitHub Docs: About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)
* [GitHub Docs: Managing a branch protection rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule)

### Adding Exceptions for specific repos <a href="#adding-exceptions-for-specific-repos" id="adding-exceptions-for-specific-repos"></a>

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.

<div data-with-frame="true"><img src="/files/Uytf7qkw9k01xAeTegZM" alt="Critical vulnerability status dashboard with configuration management options for projects."></div>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.aikido.dev/pr-and-release-gating/github-ci-pr-gating-via-aikido-dashboard.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.