Add comment to trim lines #621
Merged
+2
−1
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comment to the previously existing line trimming logic in the GitHub actions log processing to improve code clarity.
- Adds an explanatory comment when the tailLines count is reached to clarify the trimming action.
Comments suppressed due to low confidence (2)
pkg/github/actions.go:802
- [nitpick] The updated comment is ambiguous. Consider rephrasing it to clearly explain that the loop counts backwards to identify the exact position where the content should be trimmed once the tailLines count is met.
// Count backwards to find the nth newline from the end and a total number of lines
pkg/github/actions.go:806
- [nitpick] Consider expanding the comment to briefly mention why trimming the content at this point is beneficial, to improve clarity for future maintainers.
// If we have reached the tailLines, trim the content
SamMorrowDrums
approved these changes
Jul 1, 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.
Adds a comment to the code trimming actions logs.