> For the complete documentation index, see [llms.txt](https://docs.aviator.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aviator.co/mergequeue/how-to-guides/require-an-aviator-status-check.md).

# Require an Aviator Status Check

Aviator supports a GitHub status check you can enable for PRs or add as a required check-in branch protection rules. Learn how to set up Aviator status checks.

Aviator provides a [<mark style="color:blue;">GitHub status check</mark>](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks) that you can enable for your PRs. You can also add this status check as a required check in [<mark style="color:blue;">branch protection rules</mark>](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) to prevent developers from bypassing the merge queue. In the branch protection settings, you can find this check with the name: `aviator/checks`.

<figure><img src="https://273246003-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOAPqUQVbLbsfI5YESl32%2Fuploads%2Fd2aLE1jp9nvSw875Q3ip%2FScreen%20Shot%202023-04-20%20at%209.51.52%20AM.png?alt=media&amp;token=ccae67bd-1354-452d-879c-d74a3020f366" alt=""><figcaption><p>aviator/checks as a GitHub status check</p></figcaption></figure>

The check typically contains similar details that you also see on the sticky comment.

<figure><img src="https://273246003-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOAPqUQVbLbsfI5YESl32%2Fuploads%2FG0bNNXoPAiSm9AyBSah6%2FScreen%20Shot%202023-04-20%20at%209.51.07%20AM.png?alt=media&amp;token=64607846-44d9-4813-bfec-304af6df0019" alt=""><figcaption></figcaption></figure>

This check is enabled by default but it can be disabled using the config setting below:

```
merge_rules:
  publish_status_check: false
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.aviator.co/mergequeue/how-to-guides/require-an-aviator-status-check.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.