Update sonar-check.yml to manage coverage comments - #13878
Open
DaanHoogland wants to merge 2 commits into
Open
Conversation
Refactor coverage comment handling to update existing comments if present.
DaanHoogland
requested review from
Pearl1594 and
winterhazel
and
a lite review from Copilot
August 14, 2026 13:20
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sonar/coverage GitHub Actions workflow so the “coverage grade” bot comment on pull requests is updated in-place when a prior comment exists, instead of always posting a new comment.
Changes:
- Adds a hidden marker (
<!-- coverage-grade-bot -->) to reliably identify the workflow’s coverage-grade comment. - Switches from always creating a PR comment to listing comments and updating an existing matching comment when present.
- Falls back to creating a new comment when no existing marked comment is found.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+111
to
+116
| const { data: comments } = await github.rest.issues.listComments({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: context.issue.number, | ||
| body: body, | ||
| }); | ||
| console.log('Posted coverage grade comment'); | ||
| const existing = comments.find(c => c.user.type === 'Bot' && c.body.includes(marker)); |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #13878 +/- ##
=============================================
- Coverage 19.64% 3.41% -16.24%
=============================================
Files 6368 487 -5881
Lines 574889 41867 -533022
Branches 70353 7912 -62441
=============================================
- Hits 112935 1429 -111506
+ Misses 449684 40238 -409446
+ Partials 12270 200 -12070
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
DaanHoogland
commented
Aug 14, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (2)
.github/workflows/sonar-check.yml:115
issues.listCommentsreturns only the first page by default (30 comments). On PRs with many comments, the bot’s previous coverage comment may not be in the first page, causing this job to post a duplicate instead of updating. Paginate (or at least increaseper_page) and make the marker check resilient to a missing body.
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
.github/workflows/sonar-check.yml:114
- This step calls
issues.listComments,issues.updateComment, andissues.createComment, which requireissuespermission onGITHUB_TOKEN. The workflow currently only grantscontents: readandpull-requests: write, so these API calls can fail with 403 depending on repository default token permissions. Consider explicitly addingissues: writeunder the workflow/jobpermissions:block.
const { data: comments } = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactor coverage comment handling to update existing comments if present.
Description
This PR...
Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Bug Severity
Screenshots (if appropriate):
How Has This Been Tested?
How did you try to break this feature and the system with this change?