chore: Bug fixes and improvements to review agents and workflow [NOTASK]#1092
chore: Bug fixes and improvements to review agents and workflow [NOTASK]#1092justinegeffen merged 25 commits intomasterfrom
Conversation
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Fix missing = operator on line 71 causing 'command not found' error. Changes: - Line 71: comment_body+'' Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
f77818e to
234a000
Compare
There was a problem hiding this comment.
Pull request overview
This PR refactors the documentation review workflow to use GitHub inline suggestions instead of separate comment-based reviews. The changes consolidate multiple review agents (voice-tone, terminology, clarity) to output structured suggestions that can be applied with a single click in the GitHub PR interface.
Changes:
- Replaces comment-based review workflow with inline GitHub suggestions
- Adds new bash script to convert agent findings into GitHub suggestion format
- Disables the clarity review agent and auto-fix workflows temporarily
- Updates documentation to reflect new inline suggestion workflow
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| platform-enterprise_docs/enterprise/test-editorial-review.md | Removes test file used for agent validation |
| CLAUDE.md | Updates PR review instructions to document inline suggestion workflow |
| .github/workflows/docs-review.yml | Refactors workflow to generate structured output and post inline suggestions |
| .github/workflows/claude-pr-review.yml | Disables this workflow in favor of docs-review.yml |
| .github/scripts/post-inline-suggestions.sh | New script to convert agent findings to GitHub review suggestions |
| .github/scripts/example-review.txt | Example input format for the new script |
| .github/scripts/README.md | Documentation for the new script |
| .claude/agents/terminology.md | Updates terminology guidelines with Tower usage context |
Comments suppressed due to low confidence (2)
.github/scripts/post-inline-suggestions.sh:95
- The script accumulates suggestion text with trailing newlines (lines 92, 95), which means the final suggestion will end with an extra newline. This could cause GitHub suggestions to not match properly or add unwanted blank lines. Consider trimming trailing newlines from current_suggestion before adding it to the comment_body, or handle the last line without appending a newline.
elif [[ "$in_original" == true ]]; then
current_original+="$line"$'\n'
elif [[ "$in_suggestion" == true ]]; then
current_suggestion+="$line"$'\n'
.github/scripts/post-inline-suggestions.sh:79
- On line 77, current_line is passed as --argjson, which expects a JSON value. However, current_line contains a string from BASH_REMATCH[1]. While the jq expression includes tonumber, it would be more robust to validate that current_line is numeric before using it, or use --arg instead and convert it within jq. If current_line contains non-numeric characters, this could cause jq to fail.
comments=$(jq -n \
--argjson comments "$comments" \
--arg path "$current_file" \
--argjson line "$current_line" \
--arg body "$comment_body" \
'$comments + [{"path": $path, "line": ($line | tonumber), "body": $body}]')
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The summary job references needs.changes.outputs.docs but was missing 'changes' in its needs array, causing the condition to fail. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This workflow can be triggered manually to validate the bash script works correctly before merging to master. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Classify PRs as 'rename' or 'content' based on git diff analysis - Rename PRs (>70% renames, <5 significant content changes): Skip voice-tone and terminology - Content PRs: Run all agents (voice-tone, terminology) - Limit suggestions to 100 per PR to prevent overwhelming output - Show PR type in review summary This reduces noise on rename/refactor PRs while maintaining full editorial review for content changes. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Even 100 inline suggestions is overwhelming. Cap at 50 for better UX. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
When >50 suggestions are found: - First 50 appear as inline comments (actionable) - Full list uploaded as 'all-editorial-suggestions' artifact - Comment links to workflow run to download complete list - Suggestions retained for 30 days This allows reviewing all suggestions without overwhelming the PR UI. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
CLAUDE.md (user-facing): - Added Quick Start section - Comprehensive PR review workflow explanation - Manual re-run instructions - Artifact download guide - Troubleshooting section - Directory structure with file counts .claude/README.md (technical): - Balanced coverage of skills AND agents - Agent definitions and configurations - GitHub Actions integration details - Development guidelines - Architecture overview Both files now follow industry-standard documentation structure with clear separation between user guide and technical implementation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove specific terminology examples (Tower, RNA-Seq, UI elements) from user guide. Users can reference .claude/agents/terminology.md for detailed rules.
Add clear explanation of editorial and API workflows with step-by-step flow descriptions and component listings.
Specify 'agents, skills, and configuration' instead of just 'configuration' for clarity.
Change from level 3 (###) to level 2 (##) to match other main sections.
Add missing workflow file, scripts, and trigger details to match actual implementation.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 11 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
…/docs into fix-bash-syntax-error
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
…/docs into fix-bash-syntax-error
Critical bugfixes:
Enhanced features: