actions/setup-java
1
0
Fork 0
mirror of https://github.com/actions/setup-java.git synced 2026-08-25 19:42:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Prepare documentation for v6 release (#1253)

Browse Source 
Update public examples and release messaging to make v6 the recommended stable version, include late-cycle v6 features, and increase the JetBrains test timeout to avoid cold-run flakes.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 24e3d384-3bda-4ca3-b1fc-f49e340c174f
This commit is contained in:
Bruno Borges
2026-08-24 11:49:23 -04:00
committed by GitHub
parent 59b3450628
commit dd06d9cba3
3 changed files with 23 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+21 -29
View File
@@ -9,22 +9,13 @@ Set up Java for GitHub Actions workflows. `setup-java` installs a requested Java
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
- run: java --version - run: java --version
``` ```
> [!NOTE]
> V6 is still in development on the `main` branch and is not yet recommended for production workflows. To use it, you must explicitly reference the `main` branch in your workflow, as in
>
> ```yaml
> - uses: actions/setup-java@main
> ```
>
> For production workflows, it is recommended to use the latest stable release `v5`.
## Contents ## Contents
- [What it does](#what-it-does) - [What it does](#what-it-does)
@@ -54,15 +45,16 @@ steps:
## What's new ## What's new
### V6 (in development) ### V6
- Migrated the action implementation to ESM to support the latest `@actions/*` packages. - Migrated the action implementation to ESM to support the latest `@actions/*` packages.
- Added the `oracle-openjdk` distribution for OpenJDK builds from Oracle. - Added the `oracle-openjdk`, `redhat`, and `liberica-nik` distributions.
- Added `java-version: latest` to resolve the newest stable GA release from the distribution's remote metadata. - Added `java-version: latest` to resolve the newest stable GA release from the distribution's remote metadata.
- JDK downloads now automatically verify authoritative checksums for [supported distributions](#download-integrity-and-signatures). - JDK downloads now automatically verify authoritative checksums, and package signature verification defaults to enabled for Temurin and Microsoft builds.
- Added `force-download: true` to bypass the tool cache and perform a reproducible fresh install. - Added `force-download: true` to bypass the tool cache and perform a reproducible fresh install.
- Dependency caching now supports custom paths with `cache-path` and restore-only operation with `cache-read-only: true`. - Dependency caching now supports custom paths with `cache-path` and restore-only operation with `cache-read-only: true`.
- Downloaded JDKs are now [cached](#caching-jdk-installations) automatically when `cache` is set; use `cache-jdk` to enable or disable it independently. - Downloaded JDKs are now [cached](#caching-jdk-installations) automatically when `cache` is set; use `cache-jdk` to enable or disable it independently.
- Maven configuration now supports multiple server credentials and custom dependency-resolution repositories.
- Set `problem-matcher: false` to disable Java compiler and uncaught-exception annotations. - Set `problem-matcher: false` to disable Java compiler and uncaught-exception annotations.
- GraalVM distributions now set `GRAALVM_HOME` in addition to `JAVA_HOME`. - GraalVM distributions now set `GRAALVM_HOME` in addition to `JAVA_HOME`.
- Invalid boolean values, unsupported distribution/package/platform combinations, and mismatched Maven toolchain ID counts now fail with targeted errors. - Invalid boolean values, unsupported distribution/package/platform combinations, and mismatched Maven toolchain ID counts now fail with targeted errors.
@@ -89,7 +81,7 @@ steps:
### Older versions ### Older versions
> [!WARNING] > [!WARNING]
> `actions/setup-java` versions `v1` through `v4` are deprecated. Upgrade workflows to `actions/setup-java@v5`, the latest stable release. > `actions/setup-java` versions `v1` through `v4` are deprecated. Upgrade workflows to `actions/setup-java@v6`, the latest stable release.
## Usage ## Usage
@@ -98,7 +90,7 @@ steps:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -110,7 +102,7 @@ steps:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: microsoft distribution: microsoft
java-version: '25' java-version: '25'
@@ -122,7 +114,7 @@ steps:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version-file: .java-version java-version-file: .java-version
@@ -136,7 +128,7 @@ Supported version files are `.java-version`, `.tool-versions`, and `.sdkmanrc`.
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: latest java-version: latest
@@ -267,7 +259,7 @@ Set `cache` to `maven`, `gradle`, or `sbt` to cache dependencies with minimal co
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -286,7 +278,7 @@ The primary dependency cache key is `setup-java-<runner-os>-<node-arch>-<package
Use `cache-dependency-path` to override the files used for key hashing, especially in monorepos: Use `cache-dependency-path` to override the files used for key hashing, especially in monorepos:
```yaml ```yaml
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -299,7 +291,7 @@ Use `cache-dependency-path` to override the files used for key hashing, especial
Use `cache-path` when the build tool stores dependencies outside the default location: Use `cache-path` when the build tool stores dependencies outside the default location:
```yaml ```yaml
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -338,7 +330,7 @@ The JDK cache stores the downloaded JDK installation so later runs skip the down
Set `cache-read-only: true` to restore dependency, wrapper, and JDK caches without saving changes in the post action. This is useful for pull requests, merge queues, short-lived branches, and matrix fan-out jobs that should only consume caches produced elsewhere. Set `cache-read-only: true` to restore dependency, wrapper, and JDK caches without saving changes in the post action. This is useful for pull requests, merge queues, short-lived branches, and matrix fan-out jobs that should only consume caches produced elsewhere.
```yaml ```yaml
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -354,7 +346,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -369,7 +361,7 @@ jobs:
goal: [test, verify, package] goal: [test, verify, package]
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -387,7 +379,7 @@ env:
SEGMENT_DOWNLOAD_TIMEOUT_MINS: '5' SEGMENT_DOWNLOAD_TIMEOUT_MINS: '5'
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -401,7 +393,7 @@ Install multiple Java versions by providing a multiline `java-version` value. Al
```yaml ```yaml
steps: steps:
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: | java-version: |
@@ -428,7 +420,7 @@ jobs:
name: Java ${{ matrix.java }} name: Java ${{ matrix.java }}
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: ${{ matrix.java }} java-version: ${{ matrix.java }}
@@ -445,7 +437,7 @@ jobs:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
@@ -467,7 +459,7 @@ required. See [Resolving Maven dependencies from custom repositories](docs/advan
```yaml ```yaml
steps: steps:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- uses: actions/setup-java@v5 - uses: actions/setup-java@v6
with: with:
distribution: temurin distribution: temurin
java-version: '25' java-version: '25'
__tests__/distributors/jetbrains-installer.test.ts
+2
View File
@@ -78,6 +78,8 @@ function response(
} }
describe('getAvailableVersions', () => { describe('getAvailableVersions', () => {
jest.setTimeout(10_000);
let spyHttpClient: any; let spyHttpClient: any;
let spyCoreError: any; let spyCoreError: any;
const originalGitHubToken = process.env.GITHUB_TOKEN; const originalGitHubToken = process.env.GITHUB_TOKEN;
docs/advanced-usage.md
-9
View File
@@ -39,15 +39,6 @@
See [action.yml](../action.yml) for more details on task inputs. See [action.yml](../action.yml) for more details on task inputs.
> [!NOTE]
> The examples on this page reference `actions/setup-java@v6`, which is still in
> development on the `main` branch and is not yet published as a release tag. To
> try the V6 features documented here (`cache-jdk`, `force-download`,
> `problem-matcher`, `cache-path`, `cache-read-only`, `java-version: latest`,
> `oracle-openjdk`, and the `*-env-var` input names), reference
> `actions/setup-java@main`. For production workflows use the latest stable
> release, `actions/setup-java@v5`, as shown in the [README](../README.md).
## Selecting a Java distribution ## Selecting a Java distribution
`java-version` and `distribution` select what gets installed. `java-version` may be replaced by `java-version-file`, and `distribution` is optional only when `java-version-file` points to a `.sdkmanrc` or `.tool-versions` file that carries a recognized vendor identifier. In every other case both inputs must be provided. See [Supported distributions](../README.md#Supported-distributions) for a list of available options. `java-version` and `distribution` select what gets installed. `java-version` may be replaced by `java-version-file`, and `distribution` is optional only when `java-version-file` points to a `.sdkmanrc` or `.tool-versions` file that carries a recognized vendor identifier. In every other case both inputs must be provided. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.