Skip to content

Commit 661b477

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents d0fbff7 + c715a85 commit 661b477

File tree

1 file changed

+51
-45
lines changed

1 file changed

+51
-45
lines changed

README.md

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Description
55

6-
Maven plugin for interaction with AssertThat BDD Jira plugin.
6+
Maven plugin for interaction with [AssertThat BDD Jira plugin](https://marketplace.atlassian.com/apps/1219033/assertthat-bdd-test-management-in-jira?hosting=cloud&tab=overview).
77

88
Main features are:
99

@@ -16,56 +16,62 @@ Main features are:
1616
Full plugin configuration below, optional properties can be omitted
1717

1818
```xml
19-
<plugin>
20-
<groupId>com.assertthat.plugins</groupId>
21-
<artifactId>assertthat-bdd-maven-plugin</artifactId>
22-
<version>1.1</version>
23-
<configuration>
24-
<projectId><!--Jira project id e.g. 10001--></projectId>
25-
<!--Optional can be supplied as environment variable ASSERTTHAT_ACCESS_KEY -->
26-
<accessKey><!-- ASSERTTHAT_ACCESS_KEY --></accessKey>
27-
<!--Optional can be supplied as environment variable ASSERTTHAT_SECRET_KEY -->
28-
<secretKey><!-- ASSERTTHAT_SECRET_KEY --></secretKey>
29-
</configuration>
30-
<executions>
31-
<execution>
32-
<configuration>
33-
<!--Optional - default ./features-->
34-
<outputFolder>src/test/resources/com/assertthat/features</outputFolder>
35-
<!--Optional - all features downloaded by default - should be a valid JQL-->
36-
<jql>project = XX AND key in ('XXX-1')</jql>
37-
<!--Optional - default automated (can be one of: manual/automated/both)-->
38-
<mode>automated</mode>
39-
</configuration>
40-
<id>features</id>
41-
<goals>
42-
<goal>features</goal>
43-
</goals>
44-
<phase>pre-integration-test</phase>
45-
</execution>
46-
<execution>
47-
<id>report</id>
48-
<goals>
49-
<goal>report</goal>
50-
</goals>
51-
<phase>post-integration-test</phase>
52-
<configuration>
53-
<!--Optional - default ./report-->
54-
<jsonReportFolder>target/report/surefire-reports/cucumber/</jsonReportFolder>
55-
<!--Optional - default - **/*.json -->
56-
<jsonReportIncludePattern>**/cucumber.json</jsonReportIncludePattern>
57-
</configuration>
58-
</execution>
59-
</executions>
60-
</plugin>
19+
<plugin>
20+
<groupId>com.assertthat.plugins</groupId>
21+
<artifactId>assertthat-bdd-maven-plugin</artifactId>
22+
<version>1.1</version>
23+
<configuration>
24+
<projectId>
25+
<!--Jira project id e.g. 10001-->
26+
</projectId>
27+
<!--Optional can be supplied as environment variable ASSERTTHAT_ACCESS_KEY -->
28+
<accessKey>
29+
<!-- ASSERTTHAT_ACCESS_KEY -->
30+
</accessKey>
31+
<!--Optional can be supplied as environment variable ASSERTTHAT_SECRET_KEY -->
32+
<secretKey>
33+
<!-- ASSERTTHAT_SECRET_KEY -->
34+
</secretKey>
35+
</configuration>
36+
<executions>
37+
<execution>
38+
<configuration>
39+
<!--Optional - default ./features-->
40+
<outputFolder>src/test/resources/com/assertthat/features</outputFolder>
41+
<!--Optional - all features downloaded by default - should be a valid JQL-->
42+
<jql>project = XX AND key in ('XXX-1')</jql>
43+
<!--Optional - default automated (can be one of: manual/automated/both)-->
44+
<mode>automated</mode>
45+
</configuration>
46+
<id>features</id>
47+
<goals>
48+
<goal>features</goal>
49+
</goals>
50+
<phase>pre-integration-test</phase>
51+
</execution>
52+
<execution>
53+
<id>report</id>
54+
<goals>
55+
<goal>report</goal>
56+
</goals>
57+
<phase>post-integration-test</phase>
58+
<configuration>
59+
<!--Optional - default ./report-->
60+
<jsonReportFolder>target/report/surefire-reports/cucumber/</jsonReportFolder>
61+
<!--Optional - default - **/*.json -->
62+
<jsonReportIncludePattern>**/cucumber.json</jsonReportIncludePattern>
63+
</configuration>
64+
</execution>
65+
</executions>
66+
</plugin>
6167
```
6268

6369
## Usage
6470
We recommend ruuning cucumber tests on `integration-test` phase as
6571

6672
- download features is running on `pre-integration-test` phase
67-
- report submition on `post-integration-test`
73+
- report submission on `post-integration-test`
6874

6975
### Example project
7076

71-
Refer to example project for runing using Rake [assertthat-bdd-maven-example](https://github.com/assertthat/assertthat-bdd-maven-example)
77+
Refer to example project [assertthat-bdd-maven-example](https://github.com/assertthat/assertthat-bdd-maven-example)

0 commit comments

Comments
 (0)