You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
-25Lines changed: 0 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -233,31 +233,6 @@ by using `mvn -s custom_maven_settings.xml` and perhaps some extra parameters yo
233
233
For the `servers` part, we again have the `github-packages-compas` ID that needs to be the same. We have an `OWNER` username (this is the default, because
234
234
it needs to have a username) and a password which is the GITHUB_TOKEN that's always available.
235
235
236
-
#### Basic Maven Usage
237
-
The project uses maven to manage the build. The configuration of all the tools is fairly standard, so if you have already contributed to Java projects, you should feel right at home. You can safely run the full test suite, checkstyle, see code coverage information and the generated documentation with the following command:
238
-
```
239
-
$ mvn clean verify javadoc:aggregate -Pjacoco
240
-
```
241
-
You can then inspect global code coverage in `distribution-core/target/site/jacoco-aggregate/index.html` and the javadoc in `./target/site/apidocs/index.html`.
242
-
243
-
To run a full sonarqube analysis, download and launch a sonarcube server on your machine and add the `sonar:sonar` goal at the end of the maven command line. However, it is not practical to run it every time. A more efficient alternative is to run sonarlint in an IDE.
244
-
245
-
#### Advanced Maven Usage
246
-
247
-
Using maven, you can selectively run some tests and compile only some projects and avoid long package generation tasks. Here are a few examples that are useful, feel free to compose them to find a workflow that suits you. Please consult Maven's documentation for more uses of maven.
248
-
```
249
-
# Simple run of a single test class in one project. Use either a colon followed by the ArtifactId or the directory of the project.
250
-
$ mvn test -Dtest=MyTestClass -DfailIfNoTests=false -pl :artifactid -am
251
-
# Simple run of a all tests in one project (use the correct package and artifactid)
252
-
$ mvn test -Dtest=MyProjectPackage.** -DfailIfNoTests=false -pl :artifactid -am
253
-
# Complex selection of tests
254
-
$ mvn test -Dtest=MyProject1Class#method1,MyProject1Class#method3,MyProjectPackage2.** -DfailIfNoTests=false -pl :artifact1,directory2 -am
255
-
# Sometimes problems are masked by maven trimming stacktraces:
256
-
$ mvn test -DtrimStackTrace=false
257
-
# Running tests and compiles in parallel can speed things up:
258
-
$ mvn -T 2.0C test
259
-
```
260
-
261
236
#### IDEs
262
237
If your IDE is supported by sonarlint (both IntelliJ IDEA and the Eclipse IDE are supported), it is recommended to install it. It provides immediate feedback on most sonar issues. Running tests individually is often possible in IDEs without invoking maven. Please consult the documentation of your IDE for setting up the project through maven integration.
0 commit comments