Use Check Runs API to report on status checks (success and failures) #1129
Conversation
This file contains 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
|
Woo hoo:
|
Prototype of generating checks This has a prototype to create the proper JSON format for the status check. Remaining task: Consume the output and POST the results.
POST the check results back to GitHub
BillWagner
force-pushed
the
integrate-output
branch
from
7d26735
to
b9ed8e3
Compare
This way, the only annotations that are displayed actually matter for the tool being run
BillWagner
commented
Jun 6, 2024
|
ping @jskeet for review. Once this one is merged, I'll make similar changes to the other tools. |
|
Will have a look on Monday - busy as a dad taxi today I'm afraid. |
jskeet
approved these changes
Jun 24, 2024
Warnings shouldn't be treated as errors.
|
I did update to succeed with warnings. We'll see if we want to replace that. |
|
Contributes to #1125 |
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.
Replaces #1128 (because
checks: writepermissions is honored when the permission is added on a fork - details below)This updates the TOC / Anchor update tool to create a Status Check payload and upload that as part of the workflow. A new library classes captures all warnings, errors, and information messages and adds them to an "annotations" collection. When the workflow completes, the annotations and status are sent to GitHub as a status check. That enables the errors and warnings from this tool to be displayed inline in the files tab on the PR.
My tests using #1128 failed because this PR adds the
checks:writepermission to this workflow. As a security precaution, when a PR from a fork adds write permissions to any workflow, those permissions are disabled in the PR. That prevents a malicious user from elevating their permissions.