Skip to content

Add documentation for testing Automation with arguments #132

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.

Sign up for GitHub

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

Open
senurah wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add documentation for testing Automation with arguments #132

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c6ccc13
Add docs for manually testing automation with dynamic arguments
senurah Oct 15, 2025
35e0921
Add testing instructions for automation in the overview page
senurah Oct 15, 2025
298cf0d
Add testing instructions for manual tasks with dynamic arguments
senurah Oct 16, 2025
31897f3
Update production automation instructions
senurah Oct 16, 2025
5d1f6c1
Update en/docs/quick-start-guides/schedule-your-first-automation.md
pcnfernando Oct 16, 2025
6b864ee
Update build preset names in automation instructions
senurah Oct 23, 2025
d9b3b32
Merge remote-tracking branch 'upstream/main'
senurah Feb 20, 2026
4f5db5e
Update schedule-your-first-automation page
senurah Feb 20, 2026
7ccb79d
Merge remote-tracking branch 'upstream/main'
senurah Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions en/docs/quick-start-guides/schedule-your-first-automation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,47 @@ This redirects you to the **Create New Integration in VS Code** page.
3. Add an appropriate commit message and commit.
4. Click **Sync Changes** to push the changes to remote.

## Step 5: Schedule Automation
## Optional: Test the automation manually

!!! note "Prerequisite"
Ensure the build has completed successfully (Build Status: `Completed`) before testing. You can view the Build History by clicking **Build** in the left navigation.
Comment on lines +59 to +60
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Feb 20, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Over-indented admonition body will render as a code block

The content of the !!! note "Prerequisite" admonition (line 60) has 9 leading spaces instead of 4. MkDocs/Python-Markdown strips exactly 4 spaces from admonition body lines; the remaining 5 spaces trigger indented code-block formatting, causing the prerequisite text to render as monospaced <pre> content rather than prose.

✏️ Proposed fix 
 !!! note "Prerequisite"
-         Ensure the build has completed successfully (Build Status: `Completed`) before testing. You can view the Build History by clicking **Build** in the left navigation.
+    Ensure the build has completed successfully (Build Status: `Completed`) before testing. You can view the Build History by clicking **Build** in the left navigation.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
!!! note "Prerequisite"
Ensure the build has completed successfully (Build Status: `Completed`) before testing. You can view the Build History by clicking **Build** in the left navigation.
!!! note "Prerequisite"
Ensure the build has completed successfully (Build Status: `Completed`) before testing. You can view the Build History by clicking **Build** in the left navigation.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@en/docs/quick-start-guides/schedule-your-first-automation.md` around lines 59
- 60, The admonition body under the '!!! note "Prerequisite"' block is
over-indented (9 spaces) which causes it to render as a code block; locate the
admonition in the file and reduce the leading indentation of the body line
"Ensure the build has completed successfully..." to exactly 4 spaces (or remove
all leading spaces so it is flush with the admonition), ensuring
MkDocs/Python‑Markdown will treat it as normal prose rather than an indented
code block.


You can execute your automation directly from the **Development** card on the **Overview** page:

1. On the Overview page, locate the **Development** card.
2. Click **Test** to run your automation immediately.

!!! info "Inject Dynamic Values into Your Application as Command-Line Arguments"
To pass dynamic values to your application when testing manually, follow these steps:

1. Click the drop-down icon next to **Test** and then click **Test with Arguments**.
2. In the **Runtime Arguments** pane, enter the arguments you want to pass to your application.
3. Click **Execute**. This triggers the task with the specified arguments.

The capability to run a manual task with arguments is supported for the following build presets:

=== "WSO2 MI"
To explore a WSO2 MI-based manual task with arguments, try out the [Weather to Logs Task](https://github.com/wso2/choreo-samples/tree/main/weather-to-logs-mi-manual-task) sample. For instructions, see the `README.md` file in the sample repository.

!!! info
When working on WSO2 MI projects and deploying a WSO2 MI integration as a manual task in Devant, use the WSO2 MI automation mode. For details, see [Running the Micro Integrator in Automation Mode](https://mi.docs.wso2.com/en/latest/install-and-setup/install/running-the-mi-in-automation-mode/).

=== "WSO2 BI"
To explore a Ballerina manual task with arguments, try out the [Weather to Email Task](https://github.com/wso2/choreo-samples/tree/main/weather-to-email-integration) sample. For instructions, see the `README.md` file in the sample repository.

!!! info
If you want to pass arguments to Ballerina main functions, use the **Test with Arguments** capability. For details on the arguments you can pass, see the [Ballerina documentation](https://ballerina.io/learn/by-example/main-function/). You can also override configurable values in the same manner. For more information, see [Provide values to configurable variables](https://ballerina.io/learn/provide-values-to-configurable-variables/#provide-via-command-line-arguments).
!!! note
As user portal features are added, testing and other actions will be accessible directly from the **Overview** page, making it easier to manage and validate your automations.
Comment on lines +87 to +88
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Feb 20, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

!!! note renders nested inside list item 2, not as a standalone section note

In MkDocs/Python-Markdown, any block indented by 4 spaces following a list item is treated as a continuation of that item. The !!! note at 4-space indent will therefore render indented under "2. Click Test to run…" rather than as a top-level callout for the whole section. Since the note is a general forward-looking statement about the portal (not specific to step 2), it should sit outside the list at 0-space indent.

✏️ Proposed fix 
-    !!! note
-        As user portal features are added, testing and other actions will be accessible directly from the **Overview** page, making it easier to manage and validate your automations.
+!!! note
+    As user portal features are added, testing and other actions will be accessible directly from the **Overview** page, making it easier to manage and validate your automations.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
!!! note
As user portal features are added, testing and other actions will be accessible directly from the **Overview** page, making it easier to manage and validate your automations.
!!! note
As user portal features are added, testing and other actions will be accessible directly from the **Overview** page, making it easier to manage and validate your automations.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@en/docs/quick-start-guides/schedule-your-first-automation.md` around lines 88
- 89, The `!!! note` block is indented under the ordered list and renders as
part of item "2. Click Test to run…"; remove the 4-space indentation and move
the `!!! note` block so it starts at column 0 (no leading spaces) directly after
the list to make it a top-level callout for the whole section; target the
literal `!!! note` block and the surrounding list in the snippet and ensure
there are a blank line above the outdented note so Markdown treats it as a
separate block.


## Step 5: Schedule automation

1. Once you push the changes, the overview page of the Devant automation will automatically refresh and show you the **Latest Commit** and automatically build your automation showing the **Build Status**.

!!! note
The build process may take some time. Once complete, the build status changes to **Success**. You can see the Build History by clicking **Build** in the left navigation.
The build process may take some time. Once complete, the build status changes to **Completed**. You can see the Build History by clicking **Build** in the left navigation.

2. Once the **Build Status** shows `Build completed`, click **Test** to run your automation once.
2. Once the **Build Status** shows `Completed`, you can test your automation. See the [Optional: Test the automation manually](#optional-test-the-automation-manually) section for detailed instructions on testing, including testing with runtime arguments.
3. The development card automatically updates with execution details. Click the refresh button in the top right corner if it is not automatically updated.
4. Click **View Logs** on an execution. You will see the `Hello World` log printed along with the execution time.
5. Click **Schedule** to schedule the automation.
Expand All @@ -75,7 +108,12 @@ This redirects you to the **Create New Integration in VS Code** page.
</div>

10. After successfully testing, you can promote your automation to production by clicking the **Promote** button.
11. In critical environments (Production), you will be able to see automation metrics such as:
11. Once promoted to production, click **Run** to run your automation immediately.

!!! info
If you want to pass runtime arguments when running in production, use the **Run with Arguments** option in the same way as described above in the [Test the Automation manually](#optional-test-the-automation-manually) section.

12. In critical environments (Production), you will be able to see automation metrics such as:

- **Error Rate**: Percentage of failed executions
- **Average Duration**: Average time taken for executions
Expand Down