Skip to content

chore: Bug fixes and improvements to review agents and workflow [NOTASK]#1092

Merged
justinegeffen merged 25 commits intomasterfrom
fix-bash-syntax-error
Jan 30, 2026
Merged

chore: Bug fixes and improvements to review agents and workflow [NOTASK]#1092
justinegeffen merged 25 commits intomasterfrom
fix-bash-syntax-error

Conversation

@justinegeffen
Copy link
Contributor

@justinegeffen justinegeffen commented Jan 30, 2026

Critical bugfixes:

  • Bash syntax error fix (line 71)
  • Missing workflow dependency fix (summary job)
  • Test workflow for validation

Enhanced features:

  • PR type classification (rename vs content)
  • Conditional agent execution (skip voice-tone/terminology for renames)
  • 60 suggestion limit for manageable reviews
  • Full suggestions list downloadable as artifact

@netlify
Copy link

netlify bot commented Jan 30, 2026

Deploy Preview for seqera-docs ready!

Name Link
🔨 Latest commit 72127a2
🔍 Latest deploy log https://app.netlify.com/projects/seqera-docs/deploys/697d1ecf11d4f30008b20727
😎 Deploy Preview https://deploy-preview-1092--seqera-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@justinegeffen justinegeffen added the 1. Editor review Needs a language review label Jan 30, 2026
justinegeffen and others added 2 commits January 30, 2026 21:10
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>
justinegeffen and others added 3 commits January 30, 2026 21:31
- 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>
@justinegeffen justinegeffen changed the title bug: Fix bash syntax error in consolidated review workflow [NOTASK] chore: Bug fixes and improvements to review agents and workflow [NOTASK] Jan 30, 2026
justinegeffen and others added 8 commits January 30, 2026 21:39
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.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

justinegeffen and others added 4 commits January 30, 2026 22:20
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>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

justinegeffen and others added 5 commits January 30, 2026 23:04
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>
@justinegeffen justinegeffen added 2. Reviews complete Reviews complete. Remove label when confirmed in prod. and removed 1. Editor review Needs a language review labels Jan 30, 2026
@justinegeffen justinegeffen merged commit 95e7bef into master Jan 30, 2026
8 checks passed
@justinegeffen justinegeffen deleted the fix-bash-syntax-error branch January 30, 2026 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2. Reviews complete Reviews complete. Remove label when confirmed in prod.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants