🚨 Workflow Failure: Summarize new issues

[github-actions]

Workflow Failure Detected

Workflow: Summarize new issues
Run ID: 19906318542
Run URL: https://github.com/cbwinslow/opendiscourse/actions/runs/19906318542
Branch: main
Commit: f329940

This issue was automatically created because the workflow failed.

Next Steps

1. Review the workflow logs at the link above
2. Fix the identified issues
3. Close this issue once resolved

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and agent prompts for this issue.

• Create Plan

(or reply to this issue with @coderabbitai plan)

Examples

• Example 1
• Example 2

🔗 Similar & Duplicate Issues

Related Issues

• cbwinslow/opendiscourse#71
• cbwinslow/opendiscourse#84
• cbwinslow/opendiscourse#148
• cbwinslow/opendiscourse#163
• cbwinslow/opendiscourse#92

---

🧪 Issue enrichment is currently in early access.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

[traycerai]

Plan

Observations

The workflow summary.yml is failing because it uses the actions/ai-inference@v1 action to generate AI summaries of new issues. The main issues are: (1) shell escaping problems when passing the AI response to the gh command, (2) missing model configuration, (3) insufficient max-tokens for summaries, and (4) lack of error handling.

Approach

Fix the workflow by: (1) using environment variables and proper quoting to avoid shell escaping issues, (2) explicitly specifying a model and increasing max-tokens, (3) adding error handling and validation, and (4) using a more robust method to post comments. The fix will ensure the AI response is safely passed to the GitHub CLI without breaking on special characters.

Reasoning

I listed the repository structure, found the .github/workflows directory, read the failing summary.yml workflow file, searched the web for information about the actions/ai-inference@v1 action and common issues, and examined other workflow files to understand the repository's automation patterns.

Proposed File Changes

📄 .github/workflows/summary.yml ^(MODIFY) 🔗

Update the workflow to fix the shell escaping issues and improve reliability:

1. Add explicit model configuration: Specify the model explicitly (e.g., gpt-4o-mini or gpt-4o) and increase max-tokens to 500 or more to ensure the summary is comprehensive.

2. Fix shell escaping in the comment step: Replace the direct shell variable substitution with a safer approach:

   • Use the GITHUB_OUTPUT mechanism to write the response to a file
   • Read from the file using gh issue comment with the --body-file flag instead of inline text
   • Alternatively, use proper environment variable quoting with heredoc syntax

3. Add error handling: Add a conditional check to ensure the inference step succeeded before attempting to post the comment.

4. Improve the prompt: Make the prompt more specific about the desired output format (e.g., "Provide a concise one-paragraph summary without markdown formatting or special characters").

5. Add fallback behavior: Consider adding a step that posts a simple acknowledgment comment if the AI inference fails, so users know the workflow ran but couldn't generate a summary.

The key fix is in the "Comment with AI summary" step - instead of:

gh issue comment $ISSUE_NUMBER --body '${{ steps.inference.outputs.response }}'

Use one of these safer approaches:

Option A (Recommended): Use a temporary file:

echo "$RESPONSE" > /tmp/summary.txt
gh issue comment $ISSUE_NUMBER --body-file /tmp/summary.txt

Option B: Use heredoc with proper quoting:

gh issue comment $ISSUE_NUMBER --body "$RESPONSE"

Both approaches prevent shell injection and handle special characters correctly.

Diagram

sequenceDiagram
    participant GH as GitHub Event
    participant WF as Workflow
    participant AI as AI Inference Action
    participant File as Temp File
    participant CLI as GitHub CLI
    participant Issue as Issue Comment

    GH->>WF: Issue opened event
    WF->>WF: Checkout repository
    WF->>AI: Send prompt with issue title & body
    AI->>AI: Generate summary (with model config)
    AI-->>WF: Return AI response
    WF->>File: Write response to temp file
    WF->>CLI: Read from temp file
    CLI->>Issue: Post comment safely
    
    Note over WF,File: Avoids shell escaping issues
    Note over AI: Explicit model & max-tokens

Loading

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when absolutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end.

### Observations

The workflow `summary.yml` is failing because it uses the `actions/ai-inference@v1` action to generate AI summaries of new issues. The main issues are: (1) shell escaping problems when passing the AI response to the `gh` command, (2) missing model configuration, (3) insufficient max-tokens for summaries, and (4) lack of error handling.

### Approach

Fix the workflow by: (1) using environment variables and proper quoting to avoid shell escaping issues, (2) explicitly specifying a model and increasing max-tokens, (3) adding error handling and validation, and (4) using a more robust method to post comments. The fix will ensure the AI response is safely passed to the GitHub CLI without breaking on special characters.

### Reasoning

I listed the repository structure, found the `.github/workflows` directory, read the failing `summary.yml` workflow file, searched the web for information about the `actions/ai-inference@v1` action and common issues, and examined other workflow files to understand the repository's automation patterns.

## Mermaid Diagram

sequenceDiagram
    participant GH as GitHub Event
    participant WF as Workflow
    participant AI as AI Inference Action
    participant File as Temp File
    participant CLI as GitHub CLI
    participant Issue as Issue Comment

    GH->>WF: Issue opened event
    WF->>WF: Checkout repository
    WF->>AI: Send prompt with issue title & body
    AI->>AI: Generate summary (with model config)
    AI-->>WF: Return AI response
    WF->>File: Write response to temp file
    WF->>CLI: Read from temp file
    CLI->>Issue: Post comment safely
    
    Note over WF,File: Avoids shell escaping issues
    Note over AI: Explicit model & max-tokens

## Proposed File Changes

### .github/workflows/summary.yml(MODIFY)

Update the workflow to fix the shell escaping issues and improve reliability:

1. **Add explicit model configuration**: Specify the model explicitly (e.g., `gpt-4o-mini` or `gpt-4o`) and increase `max-tokens` to 500 or more to ensure the summary is comprehensive.

2. **Fix shell escaping in the comment step**: Replace the direct shell variable substitution with a safer approach:
   - Use the `GITHUB_OUTPUT` mechanism to write the response to a file
   - Read from the file using `gh issue comment` with the `--body-file` flag instead of inline text
   - Alternatively, use proper environment variable quoting with heredoc syntax

3. **Add error handling**: Add a conditional check to ensure the inference step succeeded before attempting to post the comment.

4. **Improve the prompt**: Make the prompt more specific about the desired output format (e.g., "Provide a concise one-paragraph summary without markdown formatting or special characters").

5. **Add fallback behavior**: Consider adding a step that posts a simple acknowledgment comment if the AI inference fails, so users know the workflow ran but couldn't generate a summary.

The key fix is in the "Comment with AI summary" step - instead of:
```yaml
gh issue comment $ISSUE_NUMBER --body '${{ steps.inference.outputs.response }}'
```

Use one of these safer approaches:

**Option A (Recommended)**: Use a temporary file:
```yaml
echo "$RESPONSE" > /tmp/summary.txt
gh issue comment $ISSUE_NUMBER --body-file /tmp/summary.txt
```

**Option B**: Use heredoc with proper quoting:
```yaml
gh issue comment $ISSUE_NUMBER --body "$RESPONSE"
```

Both approaches prevent shell injection and handle special characters correctly.

---

Developer Humor

🤖 An AI tried to summarize an issue,\n> But shell quotes caused quite the dismissal.\n> With special chars galore,\n> The workflow hit the floor,\n> Now we'll use files—much more official! 📝✨

---

Execution Information

Branch: main
Commit: f329940

---

💡 Tips

Supported Commands (Inside Comments)

• Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

• Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
• Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.