|
1 | | -== Configuration |
| 1 | += Configuration |
2 | 2 |
|
3 | | -The plugin provides sensible defaults, but you can customize if needed by adding a `<configuration>` block in your `pom.xml`: |
| 3 | +The plugin provides sensible defaults that match the standard Maven project layout. |
| 4 | +Override only what you need by adding a `<configuration>` block in your `pom.xml`. |
4 | 5 |
|
5 | | -=== Complete Configuration Example |
| 6 | +== Configuration reference |
6 | 7 |
|
7 | | -[source,xml] |
8 | | ----- |
9 | | -<configuration> |
10 | | - <!-- Path to requirements annotations YAML --> |
11 | | - <!-- Default: ${project.build.directory}/generated-sources/annotations/resources/annotations.yml --> |
12 | | - <requirementsAnnotationsFile> |
13 | | - ${project.build.directory}/generated-sources/annotations/resources/annotations.yml |
14 | | - </requirementsAnnotationsFile> |
| 8 | +[cols="1,1,2,2",options="header"] |
| 9 | +|=== |
| 10 | +|Parameter |Type |Default |Description |
15 | 11 |
|
16 | | - <!-- Path to SVCS (Software Verification Cases) annotations YAML --> |
17 | | - <!-- Default: ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml --> |
18 | | - <svcsAnnotationsFile> |
19 | | - ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml |
20 | | - </svcsAnnotationsFile> |
| 12 | +|`requirementsAnnotationsFile` |
| 13 | +|`File` |
| 14 | +|`${project.build.directory}/generated-sources/annotations/resources/annotations.yml` |
| 15 | +|Requirements annotations YAML file generated by the annotation processor for the main source set |
21 | 16 |
|
22 | | - <!-- Output directory for ZIP and combined annotations --> |
23 | | - <!-- Default: ${project.build.directory}/reqstool --> |
24 | | - <outputDirectory>${project.build.directory}/reqstool</outputDirectory> |
| 17 | +|`svcsAnnotationsFile` |
| 18 | +|`File` |
| 19 | +|`${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml` |
| 20 | +|SVCs annotations YAML file generated by the annotation processor for the test source set |
25 | 21 |
|
26 | | - <!-- Dataset directory containing requirements.yml and optional files --> |
27 | | - <!-- Default: ${project.basedir}/reqstool --> |
28 | | - <datasetPath>${project.basedir}/reqstool</datasetPath> |
| 22 | +|`outputDirectory` |
| 23 | +|`File` |
| 24 | +|`${project.build.directory}/reqstool` |
| 25 | +|Output directory for the ZIP artifact and combined `annotations.yml` |
29 | 26 |
|
30 | | - <!-- Test result file patterns (Ant-style) --> |
31 | | - <testResults> |
32 | | - <testResult>target/surefire-reports/**/*.xml</testResult> |
33 | | - <testResult>target/failsafe-reports/**/*.xml</testResult> |
34 | | - </testResults> |
| 27 | +|`datasetPath` |
| 28 | +|`File` |
| 29 | +|`${project.basedir}/reqstool` |
| 30 | +|Directory containing `requirements.yml` and optional supporting files |
35 | 31 |
|
36 | | - <!-- Skip entire plugin execution (default: false) --> |
37 | | - <skip>false</skip> |
| 32 | +|`testResults` |
| 33 | +|`String[]` |
| 34 | +|_(none)_ |
| 35 | +|Ant-style glob patterns for test result XML files to include in the ZIP |
38 | 36 |
|
39 | | - <!-- Skip ZIP assembly but keep annotation combining (default: false) --> |
40 | | - <skipAssembleZipArtifact>false</skipAssembleZipArtifact> |
| 37 | +|`skip` |
| 38 | +|`boolean` |
| 39 | +|`false` |
| 40 | +|Skip all plugin execution |
41 | 41 |
|
42 | | - <!-- Skip artifact attachment for deployment (default: false) --> |
43 | | - <skipAttachZipArtifact>false</skipAttachZipArtifact> |
44 | | -</configuration> |
45 | | ----- |
46 | | - |
47 | | -=== Configuration Parameters |
48 | | - |
49 | | -==== requirementsAnnotationsFile |
| 42 | +|`skipAssembleZipArtifact` |
| 43 | +|`boolean` |
| 44 | +|`false` |
| 45 | +|Skip ZIP assembly; annotations are still combined into `annotations.yml` |
50 | 46 |
|
51 | | -The `requirementsAnnotationsFile` parameter specifies the path to the requirements annotations file. |
52 | | -Defaults to the value set below. |
53 | | - |
54 | | -[source,xml] |
55 | | ----- |
56 | | -<requirementsAnnotationsFile> |
57 | | - ${project.build.directory}/generated-sources/annotations/resources/annotations.yml |
58 | | -</requirementsAnnotationsFile> |
59 | | ----- |
| 47 | +|`skipAttachZipArtifact` |
| 48 | +|`boolean` |
| 49 | +|`false` |
| 50 | +|Skip attaching the ZIP artifact to the Maven project |
| 51 | +|=== |
60 | 52 |
|
61 | | -==== svcsAnnotationsFile |
| 53 | +== Dataset directory |
62 | 54 |
|
63 | | -The `svcsAnnotationsFile` parameter specifies the path to the SVCS (Software Verification Cases) annotations file. |
64 | | -Defaults to the value set below. |
| 55 | +The `datasetPath` directory must contain at minimum a `requirements.yml` file. |
| 56 | +Optional files in the same directory are included if present. |
65 | 57 |
|
66 | | -[source,xml] |
67 | | ----- |
68 | | -<svcsAnnotationsFile> |
69 | | - ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml |
70 | | -</svcsAnnotationsFile> |
71 | | ----- |
| 58 | +[cols="1,1",options="header"] |
| 59 | +|=== |
| 60 | +|File |Required |
72 | 61 |
|
73 | | -==== outputDirectory |
| 62 | +|`requirements.yml` |
| 63 | +|Yes |
74 | 64 |
|
75 | | -The `outputDirectory` parameter specifies the path to where to put the generated output. |
76 | | -Defaults to the value set below. |
| 65 | +|`software_verification_cases.yml` |
| 66 | +|No |
77 | 67 |
|
78 | | -[source,xml] |
79 | | ----- |
80 | | -<outputDirectory>${project.build.directory}/reqstool</outputDirectory> |
81 | | ----- |
| 68 | +|`manual_verification_results.yml` |
| 69 | +|No |
| 70 | +|=== |
82 | 71 |
|
83 | | -==== datasetPath |
| 72 | +== Minimal configuration |
84 | 73 |
|
85 | | -The `datasetPath` parameter specifies the path to the dataset directory containing `requirements.yml` and optional files. |
86 | | -Defaults to the value set below. |
| 74 | +Only `datasetPath` needs to be set when the dataset lives outside the default `reqstool/` directory: |
87 | 75 |
|
88 | 76 | [source,xml] |
89 | 77 | ---- |
90 | | -<datasetPath>${project.basedir}/reqstool</datasetPath> |
91 | | ----- |
92 | | - |
93 | | -==== testResults |
94 | | - |
95 | | -The `testResults` parameter specifies one or more test result file patterns. |
96 | | -Supports Ant-style pattern matching. |
97 | | - |
98 | | -[source,xml] |
99 | | ----- |
100 | | -<testResults> |
101 | | - <testResult>target/surefire-reports/**/*.xml</testResult> |
102 | | - <testResult>target/failsafe-reports/**/*.xml</testResult> |
103 | | -</testResults> |
104 | | ----- |
105 | | - |
106 | | -==== skip |
107 | | - |
108 | | -Skip the execution of the entire plugin. |
109 | | -Defaults to `false`. |
110 | | - |
111 | | -[source,xml] |
112 | | ----- |
113 | | -<skip>false</skip> |
| 78 | +<configuration> |
| 79 | + <datasetPath>${project.basedir}/docs/reqstool</datasetPath> |
| 80 | +</configuration> |
114 | 81 | ---- |
115 | 82 |
|
116 | | -==== skipAssembleZipArtifact |
117 | | - |
118 | | -Skip ZIP artifact assembly but continue with annotation combining. |
119 | | -Defaults to `false`. |
| 83 | +== Complete configuration example |
120 | 84 |
|
121 | 85 | [source,xml] |
122 | 86 | ---- |
123 | | -<skipAssembleZipArtifact>false</skipAssembleZipArtifact> |
| 87 | +<configuration> |
| 88 | + <requirementsAnnotationsFile> |
| 89 | + ${project.build.directory}/generated-sources/annotations/resources/annotations.yml |
| 90 | + </requirementsAnnotationsFile> |
| 91 | + <svcsAnnotationsFile> |
| 92 | + ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml |
| 93 | + </svcsAnnotationsFile> |
| 94 | + <outputDirectory>${project.build.directory}/reqstool</outputDirectory> |
| 95 | + <datasetPath>${project.basedir}/docs/reqstool</datasetPath> |
| 96 | + <testResults> |
| 97 | + <testResult>target/surefire-reports/**/*.xml</testResult> |
| 98 | + <testResult>target/failsafe-reports/**/*.xml</testResult> |
| 99 | + </testResults> |
| 100 | + <skip>false</skip> |
| 101 | + <skipAssembleZipArtifact>false</skipAssembleZipArtifact> |
| 102 | + <skipAttachZipArtifact>false</skipAttachZipArtifact> |
| 103 | +</configuration> |
124 | 104 | ---- |
125 | 105 |
|
126 | | -==== skipAttachZipArtifact |
| 106 | +== Command-line overrides |
127 | 107 |
|
128 | | -Skip artifact attachment for deployment. |
129 | | -Defaults to `false`. |
| 108 | +All parameters can be overridden on the command line using the `reqstool.` prefix: |
130 | 109 |
|
131 | | -[source,xml] |
| 110 | +[source,bash] |
132 | 111 | ---- |
133 | | -<skipAttachZipArtifact>false</skipAttachZipArtifact> |
| 112 | +mvn verify -Dreqstool.skip=true |
| 113 | +mvn verify -Dreqstool.datasetPath=/custom/path |
| 114 | +mvn verify -Dreqstool.skipAssembleZipArtifact=true |
134 | 115 | ---- |
135 | | - |
136 | | -=== Notes |
137 | | - |
138 | | -* All path parameters support both absolute and relative paths |
139 | | -* Maven property placeholders (`${...}`) can be used in all configuration values |
140 | | -* The plugin executes in the `verify` phase by default |
141 | | -* Test result paths support Ant-style pattern matching |
0 commit comments