Skip to content

Conversation

@vim-zz
Copy link
Collaborator

@vim-zz vim-zz commented Aug 3, 2025

✨ PR Description

Purpose: Remove duplicate on trigger definitions from automation examples in documentation to improve clarity.
Main changes:

  • Removed redundant on trigger blocks from LinearB AI review and description examples
  • Added blank line after tip block for code experts for consistent formatting
  • Fixed indentation of on trigger in workflow dispatch example

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀

Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@gitstream-cm
Copy link
Contributor

gitstream-cm bot commented Aug 3, 2025

Please mark which AI tools you used for this PR by checking the appropriate boxes:

  • GitHub Copilot
  • Cursor
  • ChatGPT
  • Tabnine
  • JetBrains AI Assistant
  • VSCode IntelliCode
  • Claude
  • Gemini
  • Other AI tool
  • No AI tools were used

Tip: If you want to avoid this comment in the future, you can add a label of the format 🤖 ai-* when creating your PR.

Copy link
Contributor

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

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

✨ PR Review

The PR removes on triggers from automation examples but shows inconsistent patterns - some examples have triggers completely removed while others move them to the correct location within automations.

1 issues detected:

🐞 Bug - Inconsistent handling of `on` triggers across similar automation examples creates ambiguity about the correct configuration format.

Details: The automation examples for linearb_ai_review and linearb_ai_description have their on triggers completely removed, but the run_workflow_dispatch example shows the trigger being moved inside the automation block rather than removed entirely. This creates inconsistent documentation that may lead users to create non-functional automation configurations.
File: docs/automation-actions.md (295-295)

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀


```yaml+jinja title="example - inline guidelines"
automations:
linearb_ai_review:
Copy link
Contributor

Choose a reason for hiding this comment

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

🐞 Bug - Incomplete Examples: Either move the on triggers inside each automation block (consistent with the run_workflow_dispatch pattern) or provide clear documentation explaining when triggers are needed vs when they're optional.

Suggested change
linearb_ai_review:
linearb_ai_review:
on:
- pull_request

@gitstream-cm
Copy link
Contributor

gitstream-cm bot commented Aug 3, 2025

A screenshot of the relevant part of docs after the changes is a life saver 🛟

@gitstream-cm gitstream-cm bot requested a review from a team August 3, 2025 05:37
Copy link
Collaborator

@MishaKav MishaKav left a comment

Choose a reason for hiding this comment

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

lg

@gitstream-cm gitstream-cm bot requested a review from a team August 3, 2025 05:41
@vim-zz vim-zz merged commit 6841402 into main Aug 3, 2025
15 checks passed
@vim-zz vim-zz deleted the remove-unnecessary-triggers branch August 3, 2025 05:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants