Skip to content

Commit fab0bce

Browse files
committed
Results annotation
1 parent 2c0fc33 commit fab0bce

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

docs/12-reports/03-csv.mdx

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ Where:
6262
<li><code>Feature</code> - To log the results of all features to the CSV file as they complete</li>
6363
<li><code>Feature: &lt;name&gt;</code> - To log the results of a specifically named feature only to the CSV file as it completes, where <code>&lt;name&gt;</code> is the name of the feature to log the results for</li>
6464
<li><code>Scenario</code> - To log the results of all scenarios to the CSV file as they complete</li>
65-
<li><code>Scenario: &lt;name&gt;</code> - To log the results of a specifically named scenario only to the CSV file as it completes, where <code>&lt;name&gt;</code> is the name of the scenario to log the results for</li>
65+
<li><code>Scenario: &lt;name&gt;</code> - To log the results of a specifically named scenario only to the CSV file as it completes, where <code>&lt;name&gt;</code> is the name of the scenario to log the results for. Alternatively use the preferred [`@Results`](#results-annotation) annotation which is not susceptible to name clases..</li>
6666
<li><code>StepDef</code> - To log the results of all <Link to="/docs/meta#stepdefs">StepDefs</Link> to the CSV file as they complete</li>
67-
<li><code>StepDef: &lt;name&gt;</code> - To log the results of a specifically named StepDef only to the CSV file as it completes, where <code>&lt;name&gt;</code> is the name of the StepDef to log the results for</li>
67+
<li><code>StepDef: &lt;name&gt;</code> - To log the results of a specifically named StepDef only to the CSV file as it completes, where <code>&lt;name&gt;</code> is the name of the StepDef to log the results for. Alternatively use the preferred [`@Results`](#results-annotation) annotation which is not susceptible to name clases.</li>
6868
<li>Or blank to not log any results automatically (for when you want explicitly manage CSV logging yourself through a [`@Results`](#results-annotation) annotation</li>
6969
</ul>
7070
</li>
@@ -715,6 +715,20 @@ PASSED,Gwen,Automation,2ms
715715
..
716716
```
717717

718+
The `@Results` annotation can also be used on Scenario Outlies in conjunction with the [@Examples](/docs/data-feeds#examples-annotation) annotation for the same effect.
719+
720+
<i>my.meta</i>
721+
```gherkin {4}
722+
Feature: My meta
723+
724+
@Examples('data-records.csv`)
725+
@Results('my.csv')
726+
Scenario Outline: My scenario
727+
Given my name is <name>
728+
And my job is <job>
729+
..
730+
```
731+
718732
## Logging Results
719733

720734
With the above settings in place, CSV files containing evaluated results will automatiacally be logged when you launch Gwen to execute with the `-f results` [CLI](/docs/cli) option.

0 commit comments

Comments
 (0)