Skip to content

EPMRPP-111752 || Add info about 'Change status' on Step and Log level #1061

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

Merged
maria-hambardzumian merged 1 commit into from
Jan 27, 2026
Merged

EPMRPP-111752 || Add info about 'Change status' on Step and Log level #1061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/work-with-reports/LaunchesTestItemsAttributes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 4
sidebar_label: Launches/test items attributes
description: Use attributes to organize and categorize test data for better test automation reporting tools performance and easier analysis across launches.
---
Expand Down
3 changes: 1 addition & 2 deletions docs/work-with-reports/LogLevel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
sidebar_position: 4
sidebar_position: 5
sidebar_label: Log level
description: test
---

# Log level
Expand Down
28 changes: 27 additions & 1 deletion docs/work-with-reports/ViewLaunches.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ preparation methods.

> PB + AB + SI + TI = Failed\_Test\_Cases + Skipped\_Test\_Cases +
> other\_FAILED\_methods

## Navigate to items

You can navigate to certain items using clickable values and charts with the number of tests items with all statuses available within the system:
Expand Down Expand Up @@ -139,6 +139,32 @@ Please note that that hidden item will not be visible on the LOG view for 'Next'

<MediaViewer src="https://youtu.be/1QWmSH_brVg" alt="Viewing data in our test report dashboard" type="video" />

## Change Status on Step and Log level

ReportPortal allows to manually change the execution status of Logs and Steps.
This functionality can be used to correct execution results or reflect the actual test behavior.

You can change the status of a Step or Log to one of the following values:
- Passed
- Failed
- Skipped
Comment on lines +147 to +150
Copy link

@coderabbitai coderabbitai bot Jan 24, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, let's examine the documentation file
head -160 docs/work-with-reports/ViewLaunches.mdx | tail -20

Repository: reportportal/docs

Length of output: 714

🏁 Script executed:

# Search for status definitions and validations in the codebase
rg -i "passed|failed|skipped|interrupted" --type json --type ts --type tsx --type js --type jsx -l | head -20

Repository: reportportal/docs

Length of output: 88

🏁 Script executed:

# Look for status enums or constants
rg -i "status.*enum|enum.*status|const.*status" --type ts --type tsx --type js -A 5

Repository: reportportal/docs

Length of output: 88

🏁 Script executed:

# Search for API routes or endpoints that handle status changes
rg -i "step.*status|log.*status" --type ts --type tsx --type js -l | head -15

Repository: reportportal/docs

Length of output: 88

🏁 Script executed:

# Search for "Interrupted" in the documentation
rg -i "interrupted" docs/

Repository: reportportal/docs

Length of output: 5669

🏁 Script executed:

# Look for status reference or tables that mention multiple statuses
rg -i "status.*table|status.*reference" docs/ -A 3

Repository: reportportal/docs

Length of output: 3106

🏁 Script executed:

# Check if there are any API documentation files mentioning status values
fd -e md -e mdx | xargs rg -l "status" | head -10

Repository: reportportal/docs

Length of output: 475

🏁 Script executed:

# Search for any comprehensive status documentation or tables
rg -i "passed.*failed.*skipped" docs/ -B 2 -A 2

Repository: reportportal/docs

Length of output: 25111

Add clarifying note that manual status changes are limited to Passed/Failed/Skipped.

The documentation correctly lists only Passed, Failed, and Skipped as manually changeable statuses for Steps and Logs. However, since Interrupted appears throughout the system (in statistics, widgets, and API responses), readers may be confused about why it's not included. Add a brief note clarifying that Interrupted is automatically set by the system and cannot be changed manually—for example: "Note: The Interrupted status is automatically applied by the system when test execution is interrupted and cannot be manually set."

🤖 Prompt for AI Agents 
In `@docs/work-with-reports/ViewLaunches.mdx` around lines 147 - 150, Add a brief
clarifying sentence under the "You can change the status of a Step or Log" list
explaining that the Interrupted status is not user-settable: insert a note after
the list stating something like "Note: The Interrupted status is automatically
applied by the system when test execution is interrupted and cannot be manually
set." Reference the existing list (Passed, Failed, Skipped) and the term
"Interrupted" so readers understand the distinction.


**Step level**

<MediaViewer src={require('./img/view-launches/StepLevel.png')} alt="Change status on the Step level" />

**Log level**

<MediaViewer src={require('./img/view-launches/LogLevel.png')} alt="Change status on the Log level" />

Changing the status on Log or Step level affects launch statistics and aggregated counters
(Passed, Failed, Skipped) displayed in the Launches and Debug views.

:::note
Changing the execution status does not assign, modify, or remove a defect type.<br />
Defect classification (Product Bug, Automation Bug, System Issue, No Defect, To Investigate) is a separate operation and should be performed independently during failure analysis.
:::

## Nested Steps

<MediaViewer src="https://youtu.be/t6kvmpwZE8Y" alt="Nested Steps" type="video" />
Expand Down
Binary file added docs/work-with-reports/img/view-launches/LogLevel.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/work-with-reports/img/view-launches/StepLevel.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.