Add missing 'title' field in check run error handler output dicts - #1432
Open
sbrunner wants to merge 1 commit into
Open
Add missing 'title' field in check run error handler output dicts#1432sbrunner wants to merge 1 commit into
sbrunner wants to merge 1 commit into
Conversation
The GitHub Checks API requires a 'title' field when providing 'output' in check run update requests. Three error handlers were missing this field, causing 422 Unprocessable Entity errors when trying to mark failed jobs on the check run. Also fix a stray extra closing parenthesis in one error message URL.
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.
Summary
Add the required
titlefield tooutputdicts in three check run error handlers inprocess_queue.py, and fix a stray extra closing parenthesis.Context
The GitHub Checks API returns 422 Unprocessable Entity when updating a check run with an
outputdict that lacks atitlefield. This caused cascading failures: when a transienthttpx.ReadErroroccurred during thein_progressupdate, the error handler tried to mark the check run asfailure, but that request also failed with 422 becausetitlewas missing.Observed in production: https://geoservices-int.camptocamp.com/github/logs/2593757
Implementation Details
"title": "Job failed"to the three error-handleroutputdicts (lines ~608, ~643, ~673).)in the logs URL of the genericExceptionhandler.outputdict (line ~518) already hadtitleand was not affected.Impact/Risks