Skip to content

feature: adds merge queues docs CF-2398 #2635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pedrobpereira merged 2 commits into from
Apr 17, 2026
+11 −0
Merged

feature: adds merge queues docs CF-2398 #2635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f384833
feature: adds merge queues docs CF-2398
pedrobpereira Apr 17, 2026
4049cf5
feature: adds merge queues docs CF-2398
pedrobpereira Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/getting-started/which-permissions-does-codacy-need-from-my-account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ If you log in with GitHub, Codacy requires the following [app permissions](https
<td>Read-Only</td>
<td>Codacy retrieves repository contents to get installation access tokens when integrating with your repositories and clone them, and for code coverage analysis.<br/><strong>Codacy requests this permission since September 2023.</strong> Make sure an organization owner <a href="https://docs.github.com/en/apps/using-github-apps/reviewing-and-modifying-installed-github-apps">approves Codacy GitHub App updated permissions</a> on your GitHub organization.</td>
</tr>
<tr>
<td>Merge groups</td>
<td>Read-Only</td>
<td>Codacy listens for the `merge_group` webhook event and responds to the `checks_requested` action accordingly.</td>
</tr>
<tr>
<td colspan="3"><strong>Organization permissions:</strong></td>
</tr>
Expand Down
6 changes: 6 additions & 0 deletions docs/repositories-configure/integrations/github-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,12 @@

![Comment suggesting a fix on GitHub](images/github-integration-suggest-fixes.png)

## Merge queues {: id="merge-queues"}

To support GitHub **merge queues**, our GitHub App requires **Merge Groups** permissions so it can listen for and respond to the `checks_requested` action for merge group events.

When a merge group event is triggered for a pull request in the merge queue, Codacy automatically sends a green status check for **Codacy Static Code Analysis** to the relevant commit. By the time a pull request enters the merge queue, it has already gone through Codacy's analysis — either receiving a green status or being manually bypassed. Since the pull request was already unblocked before joining the queue, always responding with green is a safe and practical approach that keeps things moving without unnecessary friction.

Check failure on line 97 in docs/repositories-configure/integrations/github-integration.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Dashes] Remove the spaces around ' — '.

Raw Output:
{"message": "[Microsoft.Dashes] Remove the spaces around ' — '.", "location": {"path": "docs/repositories-configure/integrations/github-integration.md", "range": {"start": {"line": 97, "column": 282}}}, "severity": "ERROR"}

## See also

- [Integrating Codacy with your Git workflow](../../getting-started/integrating-codacy-with-your-git-workflow.md)
Loading