feature: adds merge queues docs CF-2398#2635
Conversation
|
Overall readability score: 54.12 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Pull request overview
Adds documentation for GitHub Merge Queues support, describing the required GitHub App permissions and how Codacy behaves when merge-queue checks are requested.
Changes:
- Add a new “Merge Queues” section to the GitHub integration docs.
- Document an additional GitHub App permission related to merge queues in the permissions reference table.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/repositories-configure/integrations/github-integration.md | Documents Merge Queues behavior and required GitHub App permission for the integration. |
| docs/getting-started/which-permissions-does-codacy-need-from-my-account.md | Adds “Merge Queues” to the list of required GitHub App permissions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
While the PR successfully addresses the requirement to document GitHub Merge Queues support, there are two significant documentation errors that should be corrected before merging. First, the 'Merge groups' permission is incorrectly categorized as an 'Organization' permission when it is actually a 'Repository' permission; this will misdirect users during setup. Second, there is a naming inconsistency between 'Merge Queues' (used in the table) and 'Merge groups' (the official GitHub UI term). Codacy analysis shows the PR is otherwise up to standards.
About this PR
- There is a systemic terminology inconsistency: the permissions table uses 'Merge Queues', while the integration page and GitHub's UI use 'Merge Groups'. Additionally, the permission scope (Organization vs. Repository) is currently incorrect in the documentation.
Test suggestions
- Update the permissions table to include Merge Queues/Groups.
- Add a descriptive section to the GitHub Integration page about Merge Queues logic.
🗒️ Improve review quality by adding custom instructions
pedrobpereira
force-pushed
the
feature/merge-queues-CF-2398
branch
from
b6113ba to
4db370f
Compare
pedrobpereira
force-pushed
the
feature/merge-queues-CF-2398
branch
from
4db370f to
28cd670
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
This PR successfully addresses the requirement to document GitHub Merge Queues and the necessary 'Merge groups' permissions. Codacy analysis indicates the changes are up to standards with no quality issues detected. The primary focus for final polish should be ensuring the 'Merge groups' permission is correctly categorized as a repository-level permission (as noted in previous comments) and maintaining consistent sentence-case formatting across all headings and tables.
Test suggestions
- Verify 'Merge Groups' permission is correctly listed as Read-Only in the permissions table.
- Verify the documentation explicitly mentions the 'checks_requested' webhook action.
- Verify the explanation for the automatic green status check is included in the GitHub integration guide.
🗒️ Improve review quality by adding custom instructions
pedrobpereira
force-pushed
the
feature/merge-queues-CF-2398
branch
from
28cd670 to
ab016e7
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for GitHub Merge Queues but contains major inaccuracies previously flagged that remain unaddressed. Specifically, the 'Merge groups' permission is incorrectly categorized under 'Organization permissions' instead of 'Repository permissions', and terminology is inconsistent ('Merge Queues' vs 'Merge Groups'). Additionally, the documentation fails to clearly explain the rationale for Codacy's 'always green' status checks for merge groups, using vague language that does not meet acceptance criteria. Codacy analysis is currently up to standards, but these documentation errors should prevent merging.
About this PR
- The PR description is empty and the submission checklist has not been completed. Please provide the required context and confirm that a self-review has been performed.
Test suggestions
- Verify the 'Merge groups' permission entry is correctly placed in the Repository Permissions section of the permissions documentation.
- Verify the clarity and accuracy of the explanation regarding 'always green' status checks for merge queues in the GitHub integration guide.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the 'Merge groups' permission entry is correctly placed in the Repository Permissions section of the permissions documentation.
2. Verify the clarity and accuracy of the explanation regarding 'always green' status checks for merge queues in the GitHub integration guide.
🗒️ Improve review quality by adding custom instructions
pedrobpereira
force-pushed
the
feature/merge-queues-CF-2398
branch
from
ab016e7 to
f384833
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
👀 Live preview
live preview
🚧 To do