Skip to content

Commit

Permalink
Merge pull request #7669 from machi1990/docs/use-mvn-wrapper
Browse files Browse the repository at this point in the history
docs: use maven wrapper whenever possible
  • Loading branch information
gastaldi authored Mar 7, 2020
2 parents 885e65c + 2f4c02d commit 692796b
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/amazon-lambda-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Build the project using maven.

[source, subs=attributes+]
----
mvn clean install
./mvnw clean install
----

This will compile the code and run the unit tests included within the generated project.
Expand All @@ -68,7 +68,7 @@ to the build

[source, subs=attributes+]
----
mvn clean install -Dnative
./mvnw clean install -Dnative
----

== Simulate Amazon Lambda Deployment
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/amazon-lambda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Build the project using maven.

[source, subs=attributes+]
----
mvn clean install
./mvnw clean install
----

This will compile and package your code.
Expand Down Expand Up @@ -193,7 +193,7 @@ Lambda requires linux binaries. You can do this by passing this property to you

[source, subs=attributes+]
----
mvn clean install -Pnative -Dnative-image.docker-build=true
./mvnw clean install -Pnative -Dnative-image.docker-build=true
----

This will compile and create a native executable image. It also generates a zip file `target/function.zip`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/azure-functions-http.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ how to execute it.

[source, subs=attributes+]
----
mvn clean install azure-functions:deploy
./mvnw clean install azure-functions:deploy
----

If you haven't already created your function up at azure, the will build an uber-jar, package it, create the function
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/cdi-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Furthermore, extensions can eliminate possible false positives by producing `Unr
Finally, Quarkus provides a middle ground for the bean removal optimization where application beans are never removed whether or not they are unused,
while the optimization proceeds normally for non application classes. To use this mode, set `quarkus.arc.remove-unused-beans` to `fwk` or `framework`.

When using the dev mode (running `mvn clean compile quarkus:dev`), you can see more information about which beans are being removed
When using the dev mode (running `./mvnw clean compile quarkus:dev`), you can see more information about which beans are being removed
by enabling additional logging via the following line in your `application.properties`.

----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/container-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ To build a container image for your project, you just need to specify `quarkus.c

[source, subs=attributes+]
----
mvn clean package -Dquarkus.container-image.build=true
./mvnw clean package -Dquarkus.container-image.build=true
----

Setting the environment variable `QUARKUS_CONTAINER_IMAGE_EXECUTION` to `build` can be used instead of the system propery.
Expand Down
12 changes: 6 additions & 6 deletions docs/src/main/asciidoc/kafka-streams.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -447,8 +447,8 @@ We now can build the `producer` and `aggregator` applications:

[source, subs=attributes+]
----
mvn clean package -f producer/pom.xml
mvn clean package -f aggregator/pom.xml
./mvnw clean package -f producer/pom.xml
./mvnw clean package -f aggregator/pom.xml
----

Instead of running them directly on the host machine using the Quarkus dev mode,
Expand Down Expand Up @@ -739,7 +739,7 @@ With this code in place, it's time to rebuild the application and the `aggregato

[source, subs=attributes+]
----
mvn clean package -f aggregator/pom.xml
./mvnw clean package -f aggregator/pom.xml
docker-compose stop aggregator
docker-compose up --build -d
----
Expand Down Expand Up @@ -989,7 +989,7 @@ Then let's spin up three instances of it:

[source, subs=attributes+]
----
mvn clean package -f aggregator/pom.xml
./mvnw clean package -f aggregator/pom.xml
docker-compose stop aggregator
docker-compose up --build -d --scale aggregator=3
----
Expand Down Expand Up @@ -1087,8 +1087,8 @@ the Maven builds can be executed using the `native` profile:

[source, shell]
----
mvn clean package -f producer/pom.xml -Pnative -Dnative-image.container-runtime=docker
mvn clean package -f aggregator/pom.xml -Pnative -Dnative-image.container-runtime=docker
./mvnw clean package -f producer/pom.xml -Pnative -Dnative-image.container-runtime=docker
./mvnw clean package -f aggregator/pom.xml -Pnative -Dnative-image.container-runtime=docker
----

Now create an environment variable named `QUARKUS_MODE` and with value set to "native":
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ This can be easily done from the command line:

[source, subs=attributes+]
----
mvn clean package -Dquarkus.kubernetes.deploy=true
./mvnw clean package -Dquarkus.kubernetes.deploy=true
----

=== Building
Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/openshift.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Building is handled by the link:container-image#s2i[container-image-s2i] extensi

[source, subs=attributes+]
----
mvn clean package -Dquarkus.container-image.build=true
./mvnw clean package -Dquarkus.container-image.build=true
----

The command above will trigger an s2i binary build.
Expand All @@ -73,7 +73,7 @@ To trigger a deployment:

[source, subs=attributes+]
----
mvn clean package -Dquarkus.kubernetes.deploy=true
./mvnw clean package -Dquarkus.kubernetes.deploy=true
----

The command above will trigger a container image build and will apply the generated Openshift resources, right after.
Expand All @@ -99,7 +99,7 @@ Tip: You don't necesserily need to add this property in the `application.propert

[source, subs=attributes+]
----
mvn clean package -Dquarkus.openshift.expose=true
./mvnw clean package -Dquarkus.openshift.expose=true
----

The same applies to all properties listed below.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/spring-security.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public class GreetingControllerTest {

== Package and run the application

Run the application with: `./mvn quarkus:dev`.
Run the application with: `./mvnw quarkus:dev`.
Open your browser to http://localhost:8080/greeting.

The result should be: `{"message": "hello"}`.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/writing-extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ Note that the parameters of the mojo that will be constant for all the extension
<version>${quarkus.version}</version>
<inherited>false</inherited>
<!-- Settings for stubbing new extensions via
mvn quarkus:create-extension -N -Dquarkus.artifactIdBase=my-ext -Dquarkus.nameBase="My Extension"
./mvnw quarkus:create-extension -N -Dquarkus.artifactIdBase=my-ext -Dquarkus.nameBase="My Extension"
-->
<configuration>
<namePrefix xml:space="preserve">Quarkus - </namePrefix>
Expand Down Expand Up @@ -1828,7 +1828,7 @@ The class augmentation step of Quarkus generates classes for various purposes. S
classes/bytecode to debug or understand an issue. Classes that are related to application augmentation are currently held in
memory in a runtime class loader.

When using the dev mode (running `mvn clean compile quarkus:dev`) you can have these classes written out to disk for inspection, for this, you need to specify the
When using the dev mode (running `./mvnw clean compile quarkus:dev`) you can have these classes written out to disk for inspection, for this, you need to specify the
`quarkus.debug.generated-classes-dir` system property, for example:

[source,shell]
Expand Down

0 comments on commit 692796b

Please sign in to comment.