Setup Java

Set up Java for GitHub Actions workflows. setup-java installs a requested Java distribution, adds it to PATH, configures JAVA_HOME, and can optionally cache build dependencies for Apache Maven, Gradle, and sbt; generate Maven publishing configuration, verify JDK package signatures, manage multiple JDKs, and manage Maven toolchains.

steps:
  - uses: actions/checkout@v7
  - uses: actions/setup-java@v6
    with:
      distribution: temurin
      java-version: '25'
  - run: java --version

Contents

• What it does
• What's new
• Usage
• Inputs
• Supported distributions
• Supported version syntax
• Caching
• Multiple JDKs and Maven toolchains
• Publishing packages
• Advanced usage

What it does

• Downloads and installs Java from a supported distribution.
• Uses a requested Java version, a version file, or the latest stable release alias.
• Extracts and caches a custom JDK archive from a local file.
• Configures Maven settings.xml, Maven Toolchains, Maven GPG signing inputs, and environment-variable based credentials for publishing workflows.
• Registers Java problem matchers for compiler diagnostics and uncaught exceptions.
• Caches dependencies for Maven, Gradle, and sbt.
• Caches downloaded JDK installations between jobs.
• Verifies downloaded archive checksums when a distribution publishes authoritative checksums.
• Optionally verifies package signatures for supported distributions.

setup-java works with Java, Scala, Kotlin, Gradle, Maven, and sbt projects.

What's new

V6

• Migrated the action implementation to ESM to support the latest @actions/* packages.
• Added Oracle OpenJDK (oracle-openjdk), Red Hat Build of OpenJDK (redhat), and Liberica Native Image Kit (liberica-nik), and expanded Tencent Kona support through JDK 25.
• Added java-version: latest to resolve the newest stable GA release from the distribution's remote metadata.
• Expanded install compatibility with JEP 322 multi-field versions such as 18.0.1.1, Temurin jdk+jmods packages, and native musl artifacts on Alpine for Dragonwell, Corretto, Zulu, and Liberica.
• JDK downloads now automatically verify authoritative checksums. Package signature verification is supported for Temurin and Microsoft builds, with configurable strict enforcement.
• 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 cache keys now include .mvn/extensions.xml and gradle.properties, preventing stale restores when Maven extensions or Gradle dependency properties change.
• Downloaded JDKs are now cached automatically when cache is set; use cache-jdk to enable or disable it independently.
• Warm JDK-cached jobs can reuse cached release metadata, avoiding vendor API calls while retaining a stale-metadata fallback for vendor outages and rate limits.
• Maven configuration now supports multiple server credentials and custom dependency-resolution repositories.
• Maven signing keys are imported into an isolated temporary GPG home instead of the runner's default keyring.
• Java compiler and uncaught-exception annotations are now disabled by default. Set problem-matcher: true to enable them.
• 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.
• Renamed environment-variable-name inputs so they are not mistaken for secret values:
  • server-username -> server-username-env-var
  • server-password -> server-password-env-var
  • ->

This is the beginning of the README. Read the rest at the original. Read the full README ↗