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.

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

Doc cleanups #425

Merged
merged 1 commit into from
Sep 20, 2023
Merged
Changes from all commits
Commits
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
27 changes: 13 additions & 14 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Choose your base layer version. This can be Java 11 or anything later. Configu
</plugin>
----

If the `build-release-11` property is present in the root of your project, then this step is automatically done for you.
If the `build-release-11` file is present in the root of your project, then this step is automatically done for you.

[id='mr-jar-highest-layer']
==== Step 2: Highest layer version
Expand Down Expand Up @@ -118,9 +118,6 @@ In addition, providing additional public members in later versions is generally
Using this functionality with GitHub Actions is relatively simple. It entails adding the additional JDK
version(s) by way of a setup action, and then passing the location of each additional JDK to the build.

At the time of this writing, the commonly-used `actions/setup-java` does not provide useful environment variables
for multiple JDK installs, so it is recommended to instead use the `AdoptOpenJDK/install-jdk` action instead.

As an example, for a project that is built on Java 17 but must also be tested against JDK 11 your `build.yml`
might look something like this:

Expand All @@ -135,26 +132,28 @@ jobs:
- uses: actions/checkout@v2
name: Checkout

- uses: AdoptOpenJDK/install-jdk@v1
name: Set up JDK 17
with:
version: 17

- uses: AdoptOpenJDK/install-jdk@v1
name: Set up JDK 11
- uses: actions/setup-java@v3
name: Set up JDKs
with:
version: 11
targets: 'JAVA_HOME_11'
distribution: temurin
java-version: |
11
17

- name: Build
run: mvn -B verify --file pom.xml -Djava11.home=$JAVA_HOME_11
run: mvn -B verify --file pom.xml -Djava11.home=${{env.JAVA_HOME_11_X64}}
----

See also link:https://github.com/actions/setup-java#readme[the README for `actions/setup-java`].

Note that this configuration causes the default `JAVA_HOME` environment to be set to JDK 17.

[id='build-control-files']
== Build control files reference

These build control files are tested only for their presence.
They do not need to have any content (i.e. they can be zero-sized).

[cols="1m,2,1",options="header"]
|===
|File name|Purpose|Reference
Expand Down
Loading