Skip to content

ci: claude: Improve message and documentation about verbose mode#3920

Merged
patrickelectric merged 2 commits intobluerobotics:masterfrom
patrickelectric:fix-ci-3
Apr 30, 2026
Merged

ci: claude: Improve message and documentation about verbose mode#3920
patrickelectric merged 2 commits intobluerobotics:masterfrom
patrickelectric:fix-ci-3

Conversation

@patrickelectric
Copy link
Copy Markdown
Member

@patrickelectric patrickelectric commented Apr 30, 2026

Summary by Sourcery

Clarify automated PR review verdict formatting and document secure usage of verbose output in the Claude review workflow.

CI:

  • Configure the Claude PR review workflow to explicitly disable full output by default and document the security implications of enabling it.
  • Update the review comment template in the workflow so verdict lines are rendered without markdown formatting, ensuring GitHub emoji shortcodes resolve correctly.

Documentation:

  • Add inline workflow documentation warning about the security risks of enabling full Claude output on public repositories.

Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
@patrickelectric patrickelectric changed the title Improve message and documentation about verbose mode ci: claude: Improve message and documentation about verbose mode Apr 30, 2026
@patrickelectric patrickelectric merged commit 9ddaf8b into bluerobotics:master Apr 30, 2026
4 checks passed
@patrickelectric patrickelectric deleted the fix-ci-3 branch April 30, 2026 21:12
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Now that the verdict lines are rendered without backticks, double-check for any remaining backticked verdict labels elsewhere in the workflow or related templates to keep the emoji rendering behavior consistent across all outputs.
  • The show_full_output warning is very specific to public repositories; consider adding a brief note about behavior on private repos and forked PRs so users understand when it is and isn’t safe to toggle this for debugging.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Now that the verdict lines are rendered without backticks, double-check for any remaining backticked verdict labels elsewhere in the workflow or related templates to keep the emoji rendering behavior consistent across all outputs.
- The `show_full_output` warning is very specific to public repositories; consider adding a brief note about behavior on private repos and forked PRs so users understand when it is and isn’t safe to toggle this for debugging.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions
Copy link
Copy Markdown

Automated PR Review

0. Summary

  • Verdict: LGTM :shipit:

Two small improvements to .github/workflows/claude-pr-review.yml: explicitly pins show_full_output: "false" with a warning comment about the secret-leak risk on public repos, and strips backticks from the verdict labels (LGTM :shipit:, etc.) in the prompt and examples so GitHub renders the emoji shortcodes instead of showing them as literal text in a code span. No behavioral change to the review logic itself.

Nothing to comment, nice job 👍

Generated by PR Review Bot. This is advisory, a human reviewer must still approve.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant