PR checks: keep a findings/remediated table in the status comment - #2018
Open
marcleblanc2 wants to merge 2 commits into
Open
marcleblanc2 wants to merge 2 commits into
marcleblanc2 wants to merge 2 commits into
Conversation
The spelling, links, and redirects checks now post and update their summary comment through dev/upsert-report-comment.sh, which keeps a Total findings / Remediated table below the heading. The spelling summary is no longer minimized when resolved. dev/pr-check-metrics.sh sums the tables over merged PRs to report how many findings were fixed before merging and how many were merged in. Amp-Thread-ID: https://ampcode.com/threads/T-01a0c49e-51da-72ca-8a4a-6c0660c5e505 Co-authored-by: Amp <amp@ampcode.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
The status comment keeps a hidden list of every finding identity it has seen (the checks write them with --keys, without line numbers), so Total findings is the distinct findings any revision had and Remediated is how many of those are gone, even when a revision fixes some and adds others. Amp-Thread-ID: https://ampcode.com/threads/T-01a0c49e-51da-72ca-8a4a-6c0660c5e505 Co-authored-by: Amp <amp@ampcode.com>
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
1 participant
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.
The spelling, links, and redirects checks post one status comment each. Until now that comment was replaced on every run (and the spelling one was minimized once resolved), so the only record of what a check found was the Actions job log.
Now each check updates its comment through
dev/upsert-report-comment.sh, which keeps a table under the heading:Total findingscounts every distinct finding any revision of the PR had;Remediatedis how many of those the current revision no longer has. On a merged PR, the difference is what it was merged with. To tell a fixed finding from a new one, the checks write each finding's identity (--keys, without line numbers) and the comment keeps a hidden list of every identity seen. The spelling summary is no longer minimized.dev/pr-check-metrics.sh [merged-since]sums the tables over merged PRs, per check.As before, nothing is posted on a PR that never had findings, so clean PRs' authors get no email. Editing an existing comment sends no notification.
Spelling summaries that were minimized before this change stay minimized; I'll unminimize the ones on open PRs once this merges.