Make diagnostic to github annotation conversion infallible - #83
Draft
saecki wants to merge 2 commits into
Draft
Conversation
Instead, just omit the path and span information.
elegaanz
reviewed
Jul 20, 2026
| pub struct Annotation { | ||
| pub path: String, | ||
| #[serde(flatten)] | ||
| pub span: Option<Span>, |
Member
There was a problem hiding this comment.
I'm not sure the GitHub API will accept that, according to the docs annotations require start_line and end_line. Maybe we can instead fallback to line 1 for both?
Member
|
Another option I have considered when the conversion fails is to embed the annotation as part of the check summary message, instead of tying it to a specific line. |
Member
Author
|
Interesting, when using the This seems to be a difference between check run and workflow annotations 🤔 |
elegaanz
force-pushed
the
infallible-github-annotations
branch
4 times, most recently
from
July 21, 2026 12:26
4059cdf to
a477cad
Compare
elegaanz
force-pushed
the
infallible-github-annotations
branch
from
July 21, 2026 12:30
a477cad to
4326ea7
Compare
Member
saecki
marked this pull request as draft
July 22, 2026 13:25
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
2 participants
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.
Instead, just omit the path and span information.
Fixes #63