Add documentation for testing Automation with arguments#132
Open
Add documentation for testing Automation with arguments#132
Conversation
pcnfernando
reviewed
Oct 15, 2025
|
|
There was a problem hiding this comment.
Pull Request Overview
Adds documentation to guide users on manually testing automations and passing runtime arguments, including samples for WSO2 MI and Ballerina.
- Introduces a new "Optional: Test the Automation manually" section
- Documents "Run with Arguments" usage and provides sample links for WSO2 MI and Ballerina
- Adds an informational note about future user portal feature accessibility
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
pcnfernando
reviewed
Oct 16, 2025
pcnfernando
reviewed
Oct 16, 2025
WalkthroughUpdated the quick-start guide to add a manual testing workflow from the Overview page (including Test with Arguments and Execute), introduce runtime command-line argument injection, clarify scheduling vs. testing flow, add WSO2 MI/BI build presets, change build status wording to "Completed", add a Run/Run with Arguments production step, and expand metrics with 99th Percentile Latency and Total Executions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/docs/quick-start-guides/schedule-your-first-automation.md (1)
91-94:⚠️ Potential issue | 🟡 MinorBuild status label inconsistency: "Success" vs "
Build completed"The new note at line 92 states the build status changes to "Success", but line 94 instructs the user to wait until the status shows
`Build completed`. Only one of these can match the actual UI label; they should be consistent.✏️ Proposed fix (align note to match the existing instruction at line 94)
!!! 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 `Build completed`. You can see 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 91 - 94, Update the inconsistent build status labels in the note: choose the UI label used later ("Build completed") and replace the "Success" text inside the note block so both lines reference the same label; specifically update the note containing "**Success**" to use "`Build completed`" (or vice versa if the UI uses "Success") so the strings "Success" and "Build completed" are aligned and consistent with the instruction that checks for the Build Status.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 59-61: The text uses two different names for the same UI element
("environment card" and "**Development** card"); pick one consistent name
(preferably "**Development** card" to match the later usage) and replace the
other occurrence so both references match; update the phrase "the environment
card" to "the **Development** card" in the sentence that currently reads "You
can execute your automation directly from the environment card on the
**Overview** page:" and verify no other occurrences in this document use the old
term.
- Around line 110-111: Replace the incorrect MkDocs admonition marker "!!!info"
with the correct "!!! info" (i.e., add a space after the three exclamation
marks) so the admonition block renders as a styled callout; search for the
literal token "!!!info" in the content around the "Run with Arguments" paragraph
and update it to "!!! info".
- Around line 57-63: The "Optional: Test the Automation manually" section
appears before Step 5's build-completion requirement and will lead users to
click the **Test** button prematurely; update the content for the "Optional:
Test the Automation manually" block (the heading and the bullet instructing to
click **Test** on the Development card / Overview page) to either relocate this
entire section after Step 5 or add a prerequisite sentence stating "Ensure Build
Status: Build completed before testing" (referencing Step 5's requirement) so
users know they must wait for the build to finish before clicking **Test**.
- Around line 71-83: Replace the incorrect product name and inconsistent "manual
task" terminology in the "WSO2 MI" and "WSO2 BI" sections: change the phrase
"deploying a WSO2 MI integration as a manual task in Choreo" to reference Devant
(e.g., "deploying a WSO2 MI integration as an automation in Devant") and update
all occurrences of "manual task" / "manual task with arguments" / "manual task"
to use "automation" or "automation with arguments" as appropriate (target the
"WSO2 MI" and "WSO2 BI" headings and the sample descriptions such as "Weather to
Logs Task" and "Weather to Email Task" text), while keeping links and the
informational notes intact and ensuring any references to "Test with Arguments"
or Ballerina docs remain accurate.
---
Outside diff comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 91-94: Update the inconsistent build status labels in the note:
choose the UI label used later ("Build completed") and replace the "Success"
text inside the note block so both lines reference the same label; specifically
update the note containing "**Success**" to use "`Build completed`" (or vice
versa if the UI uses "Success") so the strings "Success" and "Build completed"
are aligned and consistent with the instruction that checks for the Build
Status.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 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.
---
Duplicate comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 75-84: Replace the remaining occurrences of the phrase "manual
task" in the shown content with "automation": change "run a manual task with
arguments" → "run an automation with arguments", "WSO2 MI-based manual task with
arguments" → "WSO2 MI-based automation with arguments", "as a manual task in
Devant" → "as an automation in Devant", and "Ballerina manual task with
arguments" → "Ballerina automation with arguments" so the terminology
consistently matches the guide title and prior changes.
Comment on lines
+88
to
+89
| !!! 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. |
There was a problem hiding this comment.
!!! 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.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 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.
---
Duplicate comments:
In `@en/docs/quick-start-guides/schedule-your-first-automation.md`:
- Around line 74-83: Replace the residual "manual task" wording in the
Automation guide block: change "run a manual task with arguments" to "run an
automation with arguments", change "a WSO2 MI-based manual task with arguments"
to "a WSO2 MI-based automation with arguments", change "as a manual task in
Devant" to "as an automation in Devant", and change "a Ballerina manual task
with arguments" to "a Ballerina automation with arguments"; these edits occur
inside the quoted block under the "WSO2 MI" and "WSO2 BI" headings so update
those exact strings accordingly to remove the leftover "manual task"
terminology.
- Around line 87-88: The block starting with the literal "!!! note" is indented
4 spaces and therefore treated as a continuation of the preceding ordered list
item ("2. Click **Test** to run your automation immediately."); remove the
4-space indent so the "!!! note" callout starts at column 0 and insert one blank
line between the end of the list item and the "!!! note" line so the note
renders as a standalone MkDocs callout rather than a list continuation.
Comment on lines
+59
to
+60
| !!! 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. |
There was a problem hiding this comment.
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.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit