LINBEE-18998 Update plugin docs with async condition guidance #782
Conversation
Note how to use async plugins in gitStream condition clauses with immediate: true flag and the implications for optimization and API calls
![orca-security-us[bot]](https://avatars.githubusercontent.com/in/276250?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
![gitstream-cm[bot]](https://avatars.githubusercontent.com/in/230441?s=60&v=4){kind=small}
There was a problem hiding this comment.
✨ PR Review
The PR adds documentation on using async plugins in condition clauses with the immediate: true flag, clarifying optimization behavior and side effects. The content is generally clear, but there are a couple of correctness and formatting issues to address.
2 issues detected:
🐞 Bug - Invalid language specifier "yaml+jinja" in code fence can lead to improper rendering.
Details: The code block for the YAML+Jinja example is fenced with an invalid language identifier "yaml+jinja", which may break syntax highlighting or rendering in some markdown processors used for the docs site.
File:docs/plugins-for-developers.md (85-85)🧾 Readability - Vague description reduces clarity for users diagnosing issues.
Details: The phrase "plugin to not work properly" is vague; it would help readers to specify the observable behavior (e.g., condition always false, plugin not invoked) to set correct expectations and aid troubleshooting.
File:docs/plugins-for-developers.md (71-71)
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀
|
|
||
| The `immediate: true` flag tells the system not to optimize plugin execution. The downside is that the plugin might be called multiple times during the workflow execution. If your plugin makes API calls, this will result in multiple API requests as well. | ||
|
|
||
| ```yaml+jinja |
There was a problem hiding this comment.
🐞 Bug - Markdown Fence Typo: Change the code fence language from yaml+jinja to a supported identifier such as jinja or ```yaml, or configure the docs engine accordingly.
| ```yaml+jinja | |
| ```jinja |
|
A screenshot of the relevant part of docs after the changes is a life saver 🛟 |
2 participants
Note how to use async plugins in gitStream condition clauses with immediate: true flag and the implications for optimization and API calls
https://linearb.atlassian.net/browse/LINBEE-18998
✨ PR Description
Purpose: Add documentation for using asynchronous plugins in conditions by explaining the need for the 'immediate: true' flag to prevent optimization issues.
Main changes:
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀