Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that JDK 17+ is Quarkus prerequisity #37697

Merged
merged 1 commit into from
Dec 12, 2023
Merged

Document that JDK 17+ is Quarkus prerequisity #37697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/_includes/prerequisites.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ifndef::prerequisites-time[]
endif::[]
* An IDE
ifdef::prerequisites-ide[{prerequisites-ide}]
* JDK 11+ installed with `JAVA_HOME` configured appropriately
* JDK 17+ installed with `JAVA_HOME` configured appropriately
ifndef::prerequisites-no-maven[]
* Apache Maven {maven-version}
endif::[]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/ansible.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ By default, the Ansible collection for Quarkus will install and use the OpenJDK
[source,bash]
----
$ ansible-playbook -i inventory ...
-e quarkus_java_package_version: java-11-openjdk
-e quarkus_java_package_version: java-17-openjdk
----
====

Expand Down
6 changes: 3 additions & 3 deletions docs/src/main/asciidoc/cli-tooling.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@

[NOTE]
====
Make sure you have a JDK installed before installing the Quarkus CLI.

Check warning on line 147 in docs/src/main/asciidoc/cli-tooling.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'verify' rather than 'Make sure' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'verify' rather than 'Make sure' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/cli-tooling.adoc", "range": {"start": {"line": 147, "column": 1}}}, "severity": "WARNING"}

Check warning on line 147 in docs/src/main/asciidoc/cli-tooling.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.", "location": {"path": "docs/src/main/asciidoc/cli-tooling.adoc", "range": {"start": {"line": 147, "column": 22}}}, "severity": "INFO"}
We haven't added an explicit dependency as we wanted to make sure you could use your preferred JDK version.

Check warning on line 148 in docs/src/main/asciidoc/cli-tooling.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using 'because' or 'while' rather than 'as'.", "location": {"path": "docs/src/main/asciidoc/cli-tooling.adoc", "range": {"start": {"line": 148, "column": 29}}}, "severity": "INFO"}

You can install a JDK with `brew install openjdk` for the latest Java version, `brew install openjdk@17` for Java 17, or `brew install openjdk@11` for Java 11.
You can install a JDK with `brew install openjdk` for the latest Java version, `brew install openjdk@17` for Java 17, or `brew install openjdk@21` for Java 21.
====

To install the Quarkus CLI using Homebrew, run the following command:
Expand Down Expand Up @@ -190,7 +190,7 @@
====
Make sure you have a JDK installed before installing the Quarkus CLI.

You can install a JDK with `choco install ojdkbuild17` for Java 17 or `choco install ojdkbuild11` for Java 11.
You can install a JDK with `choco install temurin17` for Java 17 or `choco install temurin21` for Java 21.
====

To install the Quarkus CLI using Chocolatey, run the following command:
Expand Down Expand Up @@ -226,7 +226,7 @@
[NOTE]
====
Make sure you have a JDK installed before installing the Quarkus CLI.
You can install a JDK with `scoop install openjdk17` for Java 17 or `scoop install openjdk11` for Java 11.
You can install a JDK with `scoop install openjdk17` for Java 17 or `scoop install openjdk21` for Java 21.
====
To install the Quarkus CLI using Scoop, run the following command:
[source,shell]
Expand Down
4 changes: 2 additions & 2 deletions docs/src/main/asciidoc/deploying-to-heroku.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@
* `system.properties` to configure the Java version
* `Procfile` to configure how Heroku starts your application

Quarkus needs JDK 11, so we specify that first:
Quarkus needs JDK 17, so we specify that first:

Check warning on line 95 in docs/src/main/asciidoc/deploying-to-heroku.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.", "location": {"path": "docs/src/main/asciidoc/deploying-to-heroku.adoc", "range": {"start": {"line": 95, "column": 15}}}, "severity": "INFO"}

[source,bash]
----
echo "java.runtime.version=11" >> system.properties
echo "java.runtime.version=17" >> system.properties
git add system.properties
git commit -am "Configure the Java version for Heroku."
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/funqy-gcp-functions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,9 @@
You will have a single JAR inside the `target/deployment` repository that contains your classes and all your dependencies in it.

Then you will be able to use `gcloud` to deploy your function to Google Cloud.
The `gcloud` command will be different depending on which event triggers your function.

Check warning on line 148 in docs/src/main/asciidoc/funqy-gcp-functions.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/funqy-gcp-functions.adoc", "range": {"start": {"line": 148, "column": 36}}}, "severity": "INFO"}

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[WARNING]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions-http.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ The result of the previous command is a single JAR file inside the `target/deplo

Then you will be able to use `gcloud` to deploy your function to Google Cloud.

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[source,bash]
----
Expand Down
2 changes: 1 addition & 1 deletion docs/src/main/asciidoc/gcp-functions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,9 +240,9 @@
The result of the previous command is a single JAR file inside the `target/deployment` repository that contains classes and dependencies of the project.

Then you will be able to use `gcloud` to deploy your function to Google Cloud.
The `gcloud` command will be different depending on which event triggers your function.

Check warning on line 243 in docs/src/main/asciidoc/gcp-functions.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.

Raw Output:
{"message": "[Quarkus.TermsSuggestions] Depending on the context, consider using ', which (non restrictive clause preceded by a comma)' or 'that (restrictive clause without a comma)' rather than 'which'.", "location": {"path": "docs/src/main/asciidoc/gcp-functions.adoc", "range": {"start": {"line": 243, "column": 36}}}, "severity": "INFO"}

NOTE: We will use the Java 17 runtime but you can switch to the Java 11 runtime by using `--runtime=java11` instead of `--runtime=java17` on the deploy commands.
NOTE: We will use the Java 17 runtime but you can switch to the Java 21 runtime by using `--runtime=java21` instead of `--runtime=java17` on the deploy commands.

[WARNING]
====
Expand Down
9 changes: 1 addition & 8 deletions docs/src/main/asciidoc/native-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,9 +539,9 @@

This debugging guide has the following requirements:

* JDK 11 installed with `JAVA_HOME` configured appropriately
* JDK 17 installed with `JAVA_HOME` configured appropriately

Check warning on line 542 in docs/src/main/asciidoc/native-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'OpenJDK' rather than 'JDK'.", "location": {"path": "docs/src/main/asciidoc/native-reference.adoc", "range": {"start": {"line": 542, "column": 3}}}, "severity": "INFO"}
* Apache Maven {maven-version}
* A working container runtime (Docker, podman)

Check warning on line 544 in docs/src/main/asciidoc/native-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.CaseSensitiveTerms] Use 'Podman' rather than 'podman'.

Raw Output:
{"message": "[Quarkus.CaseSensitiveTerms] Use 'Podman' rather than 'podman'.", "location": {"path": "docs/src/main/asciidoc/native-reference.adoc", "range": {"start": {"line": 544, "column": 40}}}, "severity": "INFO"}

Check warning on line 544 in docs/src/main/asciidoc/native-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'podman'?

Raw Output:
{"message": "[Quarkus.Spelling] Use correct American English spelling. Did you really mean 'podman'?", "location": {"path": "docs/src/main/asciidoc/native-reference.adoc", "range": {"start": {"line": 544, "column": 40}}}, "severity": "WARNING"}

This guide builds and executes Quarkus native executables within a Linux environment.
To offer a homogeneous experience across all environments,
Expand Down Expand Up @@ -587,16 +587,9 @@
quarkus.native.container-build=true
quarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-mandrel-builder-image:{mandrel-flavor}
quarkus.container-image.build=true
quarkus.container-image.group=test

Check warning on line 590 in docs/src/main/asciidoc/native-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'First Debugging Steps'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'First Debugging Steps'.", "location": {"path": "docs/src/main/asciidoc/native-reference.adoc", "range": {"start": {"line": 590, "column": 35}}}, "severity": "INFO"}
----

[IMPORTANT]
====
Starting with 22.3, Mandrel does not provide a `-java11` version anymore.
Note, however, that this doesn't mean that you may no longer produce native executables with Mandrel for Java 11 projects.
You can still compile your Java 11 projects using OpenJDK 11 and produce native executables from the resulting Java 11 bytecode using the `-java17` Mandrel builder images.
====

=== First Debugging Steps

As a first step, change to the project directory and build the native executable for the application:
Expand Down
Loading