|
8 | 8 | [](https://search.maven.org/search?q=g:%22com.github.bordertech.common%22%20AND%20a:%22bordertech-parent%22) |
9 | 9 |
|
10 | 10 | ## Content |
11 | | - |
12 | | -- [What is java-common](#what-is-java-common) |
13 | | -- [Why use java-common](#why-use-java-common) |
14 | | -- [Getting started](#getting-started) |
15 | | -- [Features](#features) |
16 | | -- [Configuration](#configuration) |
17 | | -- [Contributing](#contributing) |
| 11 | + - [What is java-common](#what-is-java-common) |
| 12 | + - [Why use java-common](#why-use-java-common) |
| 13 | + - [Getting started](#getting-started) |
| 14 | + - [Features](#features) |
| 15 | + - [Configuration](#configuration) |
| 16 | + - [Contributing](#contributing) |
18 | 17 |
|
19 | 18 | ## What is java-common |
20 | 19 |
|
21 | 20 | Reusable build configuration and parent pom modules for BorderTech open source projects. |
22 | 21 |
|
23 | 22 | ## Why use java-common |
24 | | - |
25 | | -- Simplifies the steps to release your project to Maven Central |
26 | | -- Enforce quality assurance and security checks on your project code |
| 23 | + - Simplifies the steps to release your project to Maven Central |
| 24 | + - Enforce quality assurance and security checks on your project code |
27 | 25 |
|
28 | 26 | ## Getting started |
29 | 27 |
|
30 | 28 | java-common provides two parent pom modules: |
31 | | - |
32 | | -- [bordertech-parent](https://github.com/BorderTech/java-common/blob/master/pom.xml) is the top level pom that configures [maven release plugin](https://maven.apache.org/maven-release/maven-release-plugin/) |
33 | | -- [qa-parent](https://github.com/BorderTech/java-common/blob/master/qa-parent/pom.xml) provides quality assurance and security checks |
| 29 | + - [bordertech-parent](https://github.com/BorderTech/java-common/blob/master/pom.xml) is the top level pom that configures [maven release plugin](https://maven.apache.org/maven-release/maven-release-plugin/) |
| 30 | + - [qa-parent](https://github.com/BorderTech/java-common/blob/master/qa-parent/pom.xml) provides quality assurance and security checks |
34 | 31 |
|
35 | 32 | Projects should generally use qa-parent as their parent POM: |
36 | 33 |
|
@@ -90,18 +87,16 @@ _Note that java projects should generally not consume this directly but instead |
90 | 87 | ### qa-parent |
91 | 88 |
|
92 | 89 | The qa-parent runs quality assurance checks on your java code using tools such as: |
93 | | - |
94 | | -- the [Checkstyle plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin) to check the code style used by the developers |
95 | | -- the [PMD plugin](https://maven.apache.org/plugins/maven-pmd-plugin) for source code analysis |
96 | | -- the [Spotbugs plugin](https://spotbugs.github.io/spotbugs-maven-plugin) that looks for bugs in Java programs using bug patterns |
| 90 | + - the [Checkstyle plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin) to check the code style used by the developers |
| 91 | + - the [PMD plugin](https://maven.apache.org/plugins/maven-pmd-plugin) for source code analysis |
| 92 | + - the [Spotbugs plugin](https://spotbugs.github.io/spotbugs-maven-plugin) that looks for bugs in Java programs using bug patterns |
97 | 93 |
|
98 | 94 | The qa-parent also runs: |
99 | | - |
100 | | -- the [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html) to check security vulnerabilities |
101 | | -- the [Enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/) to check dependency convergence |
102 | | -- the [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin/) to report project dependencies that have new versions |
103 | | -- the [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) for code coverage reports |
104 | | -- the [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin) for running unit tests |
| 95 | + - the [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html) to check security vulnerabilities |
| 96 | + - the [Enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin/) to check dependency convergence |
| 97 | + - the [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin/) to report project dependencies that have new versions |
| 98 | + - the [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) for code coverage reports |
| 99 | + - the [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin) for running unit tests |
105 | 100 |
|
106 | 101 | The qa-parent inherits all of the release functionality from bordertech-parent. |
107 | 102 |
|
@@ -129,15 +124,14 @@ Projects must ensure the necessary POM sections are overriden - these are marked |
129 | 124 | Refer to qa-parent's [pom.xml](https://github.com/BorderTech/java-common/blob/master/qa-parent/pom.xml) for all project properties. |
130 | 125 |
|
131 | 126 | Refer to the plugins used by qa-parent for all override details: |
132 | | - |
133 | | -- [Checkstyle plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin) |
134 | | -- [PMD plugin](https://maven.apache.org/plugins/maven-pmd-plugin) |
135 | | -- [Spotbugs plugin](https://spotbugs.github.io/spotbugs-maven-plugin) |
136 | | -- [OWASP plugin](https://jeremylong.github.io/DependencyCheck/dependency-check-maven) |
137 | | -- [Enforcer plugin](https://maven.apache.org/enforcer/maven-enforcer-plugin) |
138 | | -- [Version checker plugin](https://www.mojohaus.org/versions-maven-plugin) |
139 | | -- [JaCoCo plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) |
140 | | -- [Surefire plugin](https://maven.apache.org/surefire/maven-surefire-plugin) |
| 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) |
141 | 135 |
|
142 | 136 | #### Enable Static Analysis |
143 | 137 |
|
|
0 commit comments