fix(#97): prevent suggestions on GitHub from starting outside of diff hunk #115
Conversation
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
scastlara
requested review from
jbozanowski,
sdn4z and
sacha-c
as code owners
Coverage for Python 3.13 •
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Coverage for Python 3.12 •
|
||||||||||||||||||||||||||||||||||||||||||||||||||
scastlara
commented
Sep 5, 2025
| @@ -26,5 +26,7 @@ | |||
| - **File**: `{{ new_path }}` | |||
| - **Line**: `{{ line_number }}` | |||
| - **Relative line**: `{{ relative_line_number }}` | |||
| - **With suggestion**: `{{ 'Yes' if with_suggestion else 'No' }}` | |||
| - **Suggestion ready for replacement**: `{{ 'Yes' if is_suggestion_ready else 'No' }}` | |||
There was a problem hiding this comment.
New metadata to comments for future debugging.
github-actions
bot
added
fix
scastlara
changed the title
github-actions
bot
added
fix
sdn4z
approved these changes
Sep 8, 2025
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.
Looking at the manual failing cases for GitHub comment suggestions, I saw that we were failing cause the AI was deciding to create the multi-line comment outside of the diff hunk displayed in the diff (see picture). This is not allowed on GitHub.
The AI had no information to make a better decision for this, so I gave it that information in this PR.
The likelyhood of this happening will never be 0 (cause AIs are dumb), but we have a fallback with no suggestions for that scenario. On GitLab, this is not an issue because suggestions are simply markdown, and in the worse case scenario there it renders like a normal code block.
closes #97 closes #24