352 lines
13 KiB
Markdown
352 lines
13 KiB
Markdown
# Usage
|
|
- [Selecting a Java distribution](#Selecting-a-Java-distribution)
|
|
- [Eclipse Temurin](#Eclipse-Temurin)
|
|
- [Adopt](#Adopt)
|
|
- [Zulu](#Zulu)
|
|
- [Installing custom Java package type](#Installing-custom-Java-package-type)
|
|
- [Installing custom Java architecture](#Installing-custom-Java-architecture)
|
|
- [Installing custom Java distribution from local file](#Installing-Java-from-local-file)
|
|
- [Testing against different Java distributions](#Testing-against-different-Java-distributions)
|
|
- [Testing against different platforms](#Testing-against-different-platforms)
|
|
- [Publishing using Apache Maven](#Publishing-using-Apache-Maven)
|
|
- [Publishing using Gradle](#Publishing-using-Gradle)
|
|
- [Hosted Tool Cache](#Hosted-Tool-Cache)
|
|
|
|
See [action.yml](../action.yml) for more details on task inputs.
|
|
|
|
## Selecting a Java distribution
|
|
Inputs `java-version` and `distribution` are mandatory and needs to be provided. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.
|
|
|
|
### Eclipse Temurin
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'temurin'
|
|
java-version: '11'
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
### Adopt
|
|
**NOTE:** Adopt OpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from `adopt` to `temurin` to keep receiving software and security updates. See more details in the [Good-bye AdoptOpenJDK post](https://blog.adoptopenjdk.net/2021/08/goodbye-adoptopenjdk-hello-adoptium/).
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'adopt-hotspot'
|
|
java-version: '11'
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
### Zulu
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'zulu'
|
|
java-version: '11'
|
|
java-package: jdk # optional (jdk, jre, jdk+fx or jre+fx) - defaults to jdk
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
### Liberica
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'liberica'
|
|
java-version: '11'
|
|
java-package: jdk # optional (jdk, jre, jdk+fx or jre+fx) - defaults to jdk
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
### Microsoft
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'microsoft'
|
|
java-version: '11'
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
## Installing custom Java package type
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: '<distribution>'
|
|
java-version: '11'
|
|
java-package: jdk # optional (jdk or jre) - defaults to jdk
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
|
|
## Installing custom Java architecture
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: '<distribution>'
|
|
java-version: '11'
|
|
architecture: x86 # optional - defaults to x64
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
## Installing Java from local file
|
|
If your use-case requires a custom distribution or a version that is not provided by setup-java, you can download it manually and setup-java will take care of the installation and caching on the VM:
|
|
|
|
```yaml
|
|
steps:
|
|
- run: |
|
|
download_url="https://github.com/AdoptOpenJDK/openjdk11-binaries/releases/download/jdk-11.0.10%2B9/OpenJDK11U-jdk_x64_linux_hotspot_11.0.10_9.tar.gz"
|
|
wget -O $RUNNER_TEMP/java_package.tar.gz $download_url
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'jdkfile'
|
|
jdkFile: ${{ runner.temp }}/java_package.tar.gz
|
|
java-version: '11.0.0'
|
|
architecture: x64
|
|
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
## Installing Java from remote archive
|
|
If your use-case requires a custom distribution or a version that is not provided by setup-java, you can specify URL directly and setup-java will take care of the installation and caching on the VM:
|
|
|
|
```yaml
|
|
steps:
|
|
- uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'jdkfile'
|
|
jdkFile: https://github.com/AdoptOpenJDK/openjdk11-binaries/releases/download/jdk-11.0.10%2B9/OpenJDK11U-jdk_x64_linux_hotspot_11.0.10_9.tar.gz
|
|
java-version: '11.0.0'
|
|
architecture: x64
|
|
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
## Testing against different Java distributions
|
|
**NOTE:** The different distributors can provide discrepant list of available versions / supported configurations. Please refer to the official documentation to see the list of supported versions.
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-20.04
|
|
strategy:
|
|
matrix:
|
|
distribution: [ 'zulu', 'temurin' ]
|
|
java: [ '8', '11' ]
|
|
name: Java ${{ matrix.Java }} (${{ matrix.distribution }}) sample
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Setup java
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
distribution: ${{ matrix.distribution }}
|
|
java-version: ${{ matrix.java }}
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
#### Testing against different platforms
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ${{ matrix.os }}
|
|
strategy:
|
|
matrix:
|
|
java: [ '8', '11' ]
|
|
os: [ 'ubuntu-latest', 'macos-latest', 'windows-latest' ]
|
|
name: Java ${{ matrix.Java }} (${{ matrix.os }}) sample
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Setup java
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
distribution: 'temurin'
|
|
java-version: ${{ matrix.java }}
|
|
- run: java -cp java HelloWorldApp
|
|
```
|
|
|
|
## Publishing using Apache Maven
|
|
### Yaml example:
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Set up JDK 11
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
distribution: '<distribution>'
|
|
java-version: '11'
|
|
|
|
- name: Build with Maven
|
|
run: mvn -B package --file pom.xml
|
|
|
|
- name: Publish to GitHub Packages Apache Maven
|
|
run: mvn deploy
|
|
env:
|
|
GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password
|
|
|
|
- name: Set up Apache Maven Central
|
|
uses: actions/setup-java@v2
|
|
with: # running setup-java again overwrites the settings.xml
|
|
distribution: 'temurin'
|
|
java-version: '11'
|
|
server-id: maven # Value of the distributionManagement/repository/id field of the pom.xml
|
|
server-username: MAVEN_USERNAME # env variable for username in deploy
|
|
server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy
|
|
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
|
|
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
|
|
|
|
- name: Publish to Apache Maven Central
|
|
run: mvn deploy
|
|
env:
|
|
MAVEN_USERNAME: maven_username123
|
|
MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
|
|
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
|
|
```
|
|
|
|
The two `settings.xml` files created from the above example look like the following.
|
|
|
|
`settings.xml` file created for the first deploy to GitHub Packages
|
|
```xml
|
|
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
|
|
<servers>
|
|
<server>
|
|
<id>github</id>
|
|
<username>${env.GITHUB_ACTOR}</username>
|
|
<password>${env.GITHUB_TOKEN}</password>
|
|
</server>
|
|
<server>
|
|
<id>gpg.passphrase</id>
|
|
<passphrase>${env.GPG_PASSPHRASE}</passphrase>
|
|
</server>
|
|
</servers>
|
|
</settings>
|
|
```
|
|
|
|
`settings.xml` file created for the second deploy to Apache Maven Central
|
|
```xml
|
|
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
|
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
|
|
<servers>
|
|
<server>
|
|
<id>maven</id>
|
|
<username>${env.MAVEN_USERNAME}</username>
|
|
<password>${env.MAVEN_CENTRAL_TOKEN}</password>
|
|
</server>
|
|
<server>
|
|
<id>gpg.passphrase</id>
|
|
<passphrase>${env.MAVEN_GPG_PASSPHRASE}</passphrase>
|
|
</server>
|
|
</servers>
|
|
</settings>
|
|
```
|
|
|
|
***NOTE***: The `settings.xml` file is created in the Actions `$HOME/.m2` directory. If you have an existing `settings.xml` file at that location, it will be overwritten. See [below](#apache-maven-with-a-settings-path) for using the `settings-path` to change your `settings.xml` file location.
|
|
|
|
If you don't want to overwrite the `settings.xml` file, you can set `overwrite-settings: false`
|
|
|
|
### Extra setup for pom.xml:
|
|
|
|
The Maven GPG Plugin configuration in the pom.xml file should contain the following structure to avoid possible issues like `Inappropriate ioctl for device` or `gpg: signing failed: No such file or directory`:
|
|
|
|
```xml
|
|
<configuration>
|
|
<!-- Prevent gpg from using pinentry programs -->
|
|
<gpgArguments>
|
|
<arg>--pinentry-mode</arg>
|
|
<arg>loopback</arg>
|
|
</gpgArguments>
|
|
</configuration>
|
|
```
|
|
GPG 2.1 requires `--pinentry-mode` to be set to `loopback` in order to pick up the `gpg.passphrase` value defined in Maven `settings.xml`.
|
|
|
|
### GPG
|
|
|
|
If `gpg-private-key` input is provided, the private key will be written to a file in the runner's temp directory, the private key file will be imported into the GPG keychain, and then the file will be promptly removed before proceeding with the rest of the setup process. A cleanup step will remove the imported private key from the GPG keychain after the job completes regardless of the job status. This ensures that the private key is no longer accessible on self-hosted runners and cannot "leak" between jobs (hosted runners are always clean instances).
|
|
|
|
**GPG key should be exported by: `gpg --armor --export-secret-keys YOUR_ID`**
|
|
|
|
See the help docs on [Publishing a Package](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-apache-maven-for-use-with-github-packages#publishing-a-package) for more information on the `pom.xml` file.
|
|
|
|
## Apache Maven with a settings path
|
|
|
|
When using an Actions self-hosted runner with multiple shared runners the default `$HOME` directory can be shared by a number runners at the same time which could overwrite existing settings file. Setting the `settings-path` variable allows you to choose a unique location for your settings file.
|
|
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: Set up JDK 11 for Shared Runner
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
distribution: '<distribution>'
|
|
java-version: '11'
|
|
server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
|
|
settings-path: ${{ github.workspace }} # location for the settings.xml file
|
|
|
|
- name: Build with Maven
|
|
run: mvn -B package --file pom.xml
|
|
|
|
- name: Publish to GitHub Packages Apache Maven
|
|
run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
|
|
env:
|
|
GITHUB_TOKEN: ${{ github.token }}
|
|
```
|
|
|
|
## Publishing using Gradle
|
|
```yaml
|
|
jobs:
|
|
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
|
|
- name: Set up JDK 11
|
|
uses: actions/setup-java@v2
|
|
with:
|
|
distribution: '<distribution>'
|
|
java-version: '11'
|
|
|
|
- name: Build with Gradle
|
|
run: gradle build
|
|
|
|
- name: Publish to GitHub Packages
|
|
run: gradle publish
|
|
env:
|
|
USERNAME: ${{ github.actor }}
|
|
PASSWORD: ${{ secrets.GITHUB_TOKEN }}
|
|
```
|
|
|
|
***NOTE: The `USERNAME` and `PASSWORD` need to correspond to the credentials environment variables used in the publishing section of your `build.gradle`.***
|
|
|
|
See the help docs on [Publishing a Package with Gradle](https://help.github.com/en/github/managing-packages-with-github-packages/configuring-gradle-for-use-with-github-packages#example-using-gradle-groovy-for-a-single-package-in-a-repository) for more information on the `build.gradle` configuration file.
|
|
|
|
## Hosted Tool Cache
|
|
GitHub Hosted Runners have a tool cache that comes with some Java versions pre-installed. This tool cache helps speed up runs and tool setup by not requiring any new downloads. There is an environment variable called `RUNNER_TOOL_CACHE` on each runner that describes the location of this tools cache and this is where you can find the pre-installed versions of Java. `setup-java` works by taking a specific version of Java in this tool cache and adding it to PATH if the version, architecture and distribution match.
|
|
|
|
Currently, LTS versions of Adopt OpenJDK (`adopt`) are cached on the GitHub Hosted Runners.
|
|
|
|
The tools cache gets updated on a weekly basis. For information regarding locally cached versions of Java on GitHub hosted runners, check out [GitHub Actions Virtual Environments](https://github.com/actions/virtual-environments).
|