-
Notifications
You must be signed in to change notification settings - Fork 45
LINBEE-18998 Update plugin docs with async condition guidance #782
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -64,6 +64,35 @@ automations: | |||||
| !!! warning "15 Minute Time Limit" | ||||||
| gitStream actions are terminated after 15 minutes, this is a hard limit that can't be extended. | ||||||
|
|
||||||
| #### Using Async Plugin in Conditions | ||||||
|
|
||||||
| Normally, gitStream optimizes plugin execution by rendering plugins only after condition evaluation when all automation rules are decided. This optimization prevents unnecessary plugin calls. | ||||||
|
|
||||||
| However, when using an async plugin in a **condition** without the `immediate: true` flag, this optimization causes the plugin to not work properly, and you will see warning messages in the logs. | ||||||
|
|
||||||
| To use an async plugin in a condition, you must annotate the plugin with `immediate: true`: | ||||||
|
|
||||||
| ```javascript | ||||||
| module.exports = { | ||||||
| async: true, | ||||||
| immediate: true, | ||||||
| filter: myFilter | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| 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 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🐞 Bug - Markdown Fence Typo: Change the code fence language from
Suggested change
|
||||||
| automations: | ||||||
| welcome_author: | ||||||
| if: | ||||||
| - {{ "" | myFilter }} | ||||||
vim-zz marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| run: | ||||||
| - action: add-comment@v1 | ||||||
| args: | ||||||
| comment: hello world! | ||||||
| ``` | ||||||
|
|
||||||
| ### Accept Arguments | ||||||
|
|
||||||
| Filter function plugins can accept any number of arguments. The first argument must be passed to the filter function via a ` | ` operator; all subsequent arguments are passed as a set inside parenthesis. | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.