demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-10 15:11:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve "Command line build" section (#8767)

Browse Source 
* Add/explain more command line options
* Structure options in a table
* Explain when to use -DwithResolver

Signed-off-by: Wouter Born <github@maindrain.net>
This commit is contained in:
Wouter Born 2020-10-17 21:56:55 +02:00 committed by GitHub
parent dab6df14fd
commit fd1a40aaba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -63,18 +63,32 @@ To build all add-ons from the command-line, type in:
`mvn clean install` `mvn clean install`
Optionally you can skip tests (`-DskipTests`) or skip some static analysis (`-DskipChecks`). To improve build times you can add the following options to the command:
This does improve the build time but could hide problems in your code.
For binding development you want to run that command without skipping checks and tests.
To check if your code is following the [code style](https://www.openhab.org/docs/developer/guidelines.html#b-code-formatting-rules-style) run `mvn spotless:check`.
If Maven prints `[INFO] Spotless check skipped` then run `mvn spotless:check -Dspotless.check.skip=false` instead as the check is not mandatory yet.
To reformat you code run `mvn spotless:apply`.
Subsequent calls can include the `-o` for offline as in: `mvn clean install -DskipChecks -o` which will be a bit faster. | Option | Description |
| ----------------------------- | --------------------------------------------------- |
| `-DskipChecks` | Skip the static analysis (Checkstyle, FindBugs) |
| `-DskipTests` | Skip the execution of tests |
| `-Dmaven.test.skip=true` | Skip the compilation and execution of tests |
| `-Dfeatures.verify.skip=true` | Skip the Karaf feature verification |
| `-Dspotless.check.skip=true` | Skip the Spotless code style checks |
| `-o` | Work offline so Maven does not download any updates |
| `-T 1C` | Build in parallel, using 1 thread per core |
For integration tests you might need to run: `mvn clean install -DwithResolver -DskipChecks` For example you can skip checks and tests during development with:
You find a generated `.jar` file per bundle in the respective bundle `/target` directory. `mvn clean install -DskipChecks -DskipTests`
Adding these options improves the build time but could hide problems in your code.
Parallel builds are also less easy to debug and the increased load may cause timing sensitive tests to fail.
To check if your code is following the [code style](https://www.openhab.org/docs/developer/guidelines.html#b-code-formatting-rules-style) run: `mvn spotless:check`
To reformat your code so it conforms to the code style you can run: `mvn spotless:apply`
When your add-on also has an integration test in the `itests` directory, you may need to update the runbundles in the `itest.bndrun` file when the Maven dependencies change.
Maven can resolve the integration test dependencies automatically by executing: `mvn clean install -DwithResolver -DskipChecks`
The build generates a `.jar` file per bundle in the respective bundle `/target` directory.
### How to develop via an Integrated Development Environment (IDE) ### How to develop via an Integrated Development Environment (IDE)