Skip to content

cap Vale inline comments at 25 to avoid GitHub rate limits #509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jth-nw merged 2 commits into from
Mar 12, 2026
Merged

cap Vale inline comments at 25 to avoid GitHub rate limits #509

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90dc71a
fix: cap Vale inline comments at 25 to avoid GitHub rate limits
jth-nw Mar 12, 2026
bb61efd
Merge pull request #508 from netwrix/fix/doc-pr-comment-cap
jth-nw Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 32 additions & 7 deletions .github/workflows/claude-doc-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,23 @@ jobs:
echo "vale_count=$VALE_COUNT" >> "$GITHUB_OUTPUT"

if [ "$VALE_COUNT" -gt 0 ]; then
echo "Posting $VALE_COUNT Vale inline comments"
# Post as a PR review with inline comments
MAX_INLINE=25
INLINE_COMMENTS=$(echo "$COMMENTS_JSON" | jq ".[:$MAX_INLINE]")
OVERFLOW=$((VALE_COUNT - MAX_INLINE))
if [ "$OVERFLOW" -lt 0 ]; then OVERFLOW=0; fi

if [ "$OVERFLOW" -gt 0 ]; then
OVERFLOW_MD=$(echo "$COMMENTS_JSON" | jq -r ".[$MAX_INLINE:][] | \"- **\(.path)** line \(.line): \(.body)\"")
REVIEW_BODY=$(printf "**Vale found %d issue(s).** First %d shown as inline comments.\n\n<details>\n<summary>%d more issue(s)</summary>\n\n%s\n\n</details>" \
"$VALE_COUNT" "$MAX_INLINE" "$OVERFLOW" "$OVERFLOW_MD")
else
REVIEW_BODY="**Vale found ${VALE_COUNT} issue(s).** See inline comments below."
fi

echo "Posting $VALE_COUNT Vale issues ($MAX_INLINE inline, $OVERFLOW overflow)"
jq -n \
--arg body "**Vale found ${VALE_COUNT} issue(s).** See inline comments below." \
--argjson comments "$COMMENTS_JSON" \
--arg body "$REVIEW_BODY" \
--argjson comments "$INLINE_COMMENTS" \
'{"body": $body, "event": "COMMENT", "comments": $comments}' \
| gh api repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }}/reviews \
--input - 2>&1
Expand Down Expand Up @@ -411,10 +423,23 @@ jobs:
done <<< "$CHANGED_MD_FILES"

if [ "$VALE_COUNT" -gt 0 ]; then
echo "Vale still found $VALE_COUNT issue(s) after fixes"
MAX_INLINE=25
INLINE_COMMENTS=$(echo "$COMMENTS_JSON" | jq ".[:$MAX_INLINE]")
OVERFLOW=$((VALE_COUNT - MAX_INLINE))
if [ "$OVERFLOW" -lt 0 ]; then OVERFLOW=0; fi

if [ "$OVERFLOW" -gt 0 ]; then
OVERFLOW_MD=$(echo "$COMMENTS_JSON" | jq -r ".[$MAX_INLINE:][] | \"- **\(.path)** line \(.line): \(.body)\"")
REVIEW_BODY=$(printf "**Vale found %d remaining issue(s) after fixes.** First %d shown as inline comments.\n\n<details>\n<summary>%d more issue(s)</summary>\n\n%s\n\n</details>" \
"$VALE_COUNT" "$MAX_INLINE" "$OVERFLOW" "$OVERFLOW_MD")
else
REVIEW_BODY="**Vale found ${VALE_COUNT} remaining issue(s) after fixes.** See inline comments below."
fi

echo "Vale still found $VALE_COUNT issue(s) after fixes ($MAX_INLINE inline, $OVERFLOW overflow)"
jq -n \
--arg body "**Vale found ${VALE_COUNT} remaining issue(s) after fixes.** See inline comments below." \
--argjson comments "$COMMENTS_JSON" \
--arg body "$REVIEW_BODY" \
--argjson comments "$INLINE_COMMENTS" \
'{"body": $body, "event": "COMMENT", "comments": $comments}' \
| gh api repos/${REPO}/pulls/${PR_NUMBER}/reviews --input - 2>&1
else
Expand Down
Loading