Skip to content

Commit 2314448

Browse files
feature: adds merge queues docs CF-2398 (#2635)
* feature: adds merge queues docs CF-2398 * feature: adds merge queues docs CF-2398
1 parent e4f2d77 commit 2314448

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs/getting-started/which-permissions-does-codacy-need-from-my-account.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ If you log in with GitHub, Codacy requires the following [app permissions](https
6767
<td>Read-Only</td>
6868
<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>
6969
</tr>
70+
<tr>
71+
<td>Merge groups</td>
72+
<td>Read-Only</td>
73+
<td>Codacy listens for the `merge_group` webhook event and responds to the `checks_requested` action accordingly.</td>
74+
</tr>
7075
<tr>
7176
<td colspan="3"><strong>Organization permissions:</strong></td>
7277
</tr>

docs/repositories-configure/integrations/github-integration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ Adds comments on the lines of the pull request where Codacy finds new issues wit
9090

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

93+
## Merge queues {: id="merge-queues"}
94+
95+
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.
96+
97+
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.
98+
9399
## See also
94100

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

0 commit comments

Comments
 (0)