Skip to content

Commit c94d712

Browse files
Merge pull request #70 from BorderTech/jonathanaustin-patch-1
Update README.md
2 parents 64ac864 + d5fc319 commit c94d712

File tree

1 file changed

+41
-10
lines changed

1 file changed

+41
-10
lines changed

README.md

+41-10
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Projects should generally use qa-parent as their parent POM:
3737
<parent>
3838
<groupId>com.github.bordertech.common</groupId>
3939
<artifactId>qa-parent</artifactId>
40-
<version>1.0.15</version>
40+
<version>1.0.16</version>
4141
</parent>
4242
....
4343
</project>
@@ -100,6 +100,10 @@ The qa-parent also runs:
100100

101101
The qa-parent inherits all of the release functionality from bordertech-parent.
102102

103+
#### quick-build profile
104+
105+
The qa-parent provides a profile `quick-build` that for convenience skips all tests and QA. This is very useful when developing a project and a quick build of the project is required.
106+
103107
### build-tools
104108

105109
This is primarily a shared resources module used by qa-parent and potentially other BorderTech maven modules.
@@ -123,15 +127,15 @@ Projects must ensure the necessary POM sections are overriden - these are marked
123127

124128
Refer to qa-parent's [pom.xml](https://github.com/BorderTech/java-common/blob/master/qa-parent/pom.xml) for all project properties.
125129

126-
Refer to the plugins used by qa-parent for all override details:
127-
- [Checkstyle plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin)
128-
- [PMD plugin](https://maven.apache.org/plugins/maven-pmd-plugin)
129-
- [Spotbugs plugin](https://spotbugs.github.io/spotbugs-maven-plugin)
130-
- [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven)
131-
- [Enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin)
132-
- [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin)
133-
- [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html)
134-
- [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin)
130+
Refer to the plugin sections below for basic override details:
131+
- [Checkstyle plugin](#checkstyle)
132+
- [PMD plugin](#pmd-and-cpd)
133+
- [Spotbugs plugin](#spotbugs)
134+
- [OWASP plugin](#owasp)
135+
- [Enforcer plugin](#enforcer-plugin)
136+
- [Version checker plugin](#version-checker)
137+
- [JaCoCo plugin](#jacoco)
138+
- [Surefire plugin](#surefire)
135139

136140
#### Enable Static Analysis
137141

@@ -350,6 +354,33 @@ Refer to [enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plug
350354
<enforcer.fail>false</enforcer.fail>
351355
</property>
352356
```
357+
#### Version checker
358+
359+
Refer to [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin/) for all override details.
360+
361+
#### JaCoCo
362+
363+
Refer to [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) for all override details.
364+
365+
##### Skip JaCoCo
366+
367+
``` xml
368+
<property>
369+
<jacoco.skip>true</jacoco.skip>
370+
</property>
371+
```
372+
373+
#### Surefire
374+
375+
Refer to [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin) for all override details.
376+
377+
##### Skip Surefire
378+
379+
``` xml
380+
<property>
381+
<skipTests>true</skipTests>
382+
</property>
383+
```
353384

354385
#### Build tools module for override artefacts
355386

0 commit comments

Comments
 (0)