Skip to content

Commit c4ab7eb

Browse files
authored
Change dev guide to describe Maven arguments around tests a bit more (strimzi#5955)
Signed-off-by: Liam Clarke-Hutchinson <[email protected]>
1 parent a14d6ed commit c4ab7eb

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

development-docs/DEV_GUIDE.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The tests run during the build can be skipped by setting the `MVN_ARGS` environm
140140
make command:
141141

142142
make clean
143-
make MVN_ARGS='-DskipTests -DskipITs' all
143+
make MVN_ARGS='-DskipTests' all
144144

145145
4. To use the newly built images, update
146146
the `packaging/install/cluster-operator/060-Deployment-strimzi-cluster-operator.yaml` to obtain the images from your
@@ -214,7 +214,7 @@ Commonly used Make targets:
214214
- `docker_tag` for [tagging existing images](#tagging-and-pushing-docker-images)
215215
- `docker_push` for [pushing images to a Docker registry](#tagging-and-pushing-docker-images)
216216
217-
> *Note*: If you are having trouble running any of the Make commands it may help to run `mvn clean` and then `mvn install -DskipTests -DskipITs` before running the commands again.
217+
> *Note*: If you are having trouble running any of the Make commands it may help to run `mvn clean` and then `mvn install -DskipTests` before running the commands again.
218218
219219
### Java versions
220220
@@ -295,7 +295,10 @@ Unwanted versions can be commented out to speed up the build process.
295295
296296
Running `make` invokes Maven for packaging Java based applications (that is, Cluster Operator, Topic Operator, etc).
297297
The `mvn` command can be customized by setting the `MVN_ARGS` environment variable when launching `make all`. For
298-
example, `MVN_ARGS=-DskipTests make all` can be used to avoid running the unit tests and adding `-DskipITs` will skip
298+
example:
299+
* `MVN_ARGS=-DskipTests make all` will compile test code, but not run unit or integration tests
300+
* `MVN_ARGS=-DskipITs make all` will compile test code and run unit tests, but not integration tests
301+
* `MVN_ARGS=-Dmaven.test.skip=true make all` won't compile test code and won't run unit or integration tests
299302
the integration tests.
300303
301304
### Local build on Minikube
@@ -364,7 +367,7 @@ the commit if errors are detected:
364367
## IDE build problems
365368
366369
The build also uses a Java annotation processor. Some IDEs (such as IntelliJ's IDEA) by default don't run the annotation
367-
processor in their build process. You can run `mvn clean install -DskipTests -DskipITs` to run the annotation processor
370+
processor in their build process. You can run `mvn clean install -DskipTests` to run the annotation processor
368371
as part of the `maven` build, and the IDE should then be able to use the generated classes. It is also possible to
369372
configure the IDE to run the annotation processor directly.
370373

0 commit comments

Comments
 (0)