How do I cache Maven dependencies with setup-java?

Set the cache input to 'maven' and optionally specify cache-dependency-path for specific pom.xml files. The action automatically generates cache keys based on the pom.xml hash, speeding up subsequent builds by reusing cached packages.

Can setup-java install GraalVM for native image compilation?

Yes, use distribution: 'graalvm', but note license restrictions for certain versions. For JDK 17, only version 17.0.12 is available under the free license, and upgrading to JDK 21 is recommended for latest features.

What's the best way to test against multiple Java versions in GitHub Actions?

Use a matrix strategy in your workflow job to define a list of java versions, then pass each to setup-java. This allows parallel testing across different JDKs, as shown in the testing examples with strategy matrix.

setup-java vs using a Docker container with Java for CI?

setup-java is lighter and more integrated with GitHub Actions, offering faster setup and built-in caching, while Docker provides better isolation and consistency across environments but with higher overhead and manual cache management.

How to handle GPG signing when publishing artifacts with setup-java?

Provide the gpg-private-key and gpg-passphrase inputs in the action. setup-java will import the key and configure Maven or Gradle to use it for signing artifacts during publishing, simplifying secure deployments.

Why is my setup-java cache not hitting for a monorepo?

Use the cache-dependency-path input with wildcards to specify multiple dependency files, ensuring the cache key is correctly generated for all relevant parts. This is detailed in the caching section for monorepo support.

Open-Awesome

actions/setup-java: Java

MITTypeScriptv5.6.0

A GitHub Action to set up a specific Java version and manage dependencies for Maven, Gradle, and sbt projects.

GitHub

2.0k stars863 forks0 contributors

What is actions/setup-java: Java?

Setup Java is a GitHub Action that automates the installation and configuration of Java environments in CI/CD workflows. It downloads and sets up specified Java versions from various distributions, configures build tools like Maven and Gradle for publishing, and provides built-in dependency caching to optimize workflow performance.

Target Audience

Developers and teams building Java or Scala projects with GitHub Actions who need consistent, version-controlled Java environments and efficient dependency management in their CI/CD pipelines.

Value Proposition

It eliminates manual JDK setup, ensures reproducible builds across runners, and significantly reduces build times through intelligent caching, making it the standard choice for Java projects on GitHub Actions.

Overview

Set up your GitHub Actions workflow with a specific version of Java

Use Cases

Best For

Setting up specific Java versions for CI/CD workflows
Caching Maven, Gradle, or sbt dependencies to speed up builds
Testing projects against multiple Java versions and distributions
Configuring automated publishing of Java artifacts to repositories
Managing monorepos with different dependency files using wildcard caching
Installing custom or local JDK distributions in GitHub Actions

Not Ideal For

Projects using CI/CD platforms other than GitHub Actions, such as GitLab CI or Jenkins
Teams requiring advanced Gradle caching features like configuration cache or build output caching
Environments where manual control over JDK installation and version management is necessary for compliance or customization

Pros & Cons

Pros

Multi-Distribution Flexibility

Supports over 10 Java distributions including Temurin, Zulu, Corretto, and Oracle JDK, as listed in the supported distributions table, allowing teams to choose based on licensing or performance needs.

Built-In Dependency Caching

Automatically caches dependencies for Maven, Gradle, and sbt, with cache keys generated from dependency files, significantly reducing build times as described in the caching section.

Advanced CI/CD Integration

Configures Maven and Gradle for publishing with authentication and GPG signing, and supports Maven Toolchains for projects using multiple JDK versions, streamlining artifact deployment.

Flexible Version Management

Accepts exact versions, ranges, and early-access builds using SemVer notation, enabling precise environment control for testing and production workflows.

Cons

Platform Lock-In

Exclusively designed for GitHub Actions, making it unsuitable for other CI/CD systems and creating vendor dependency for workflow portability.

Basic Caching Limitations

For Gradle, the caching is rudimentary and lacks advanced features like configuration cache; the README explicitly recommends using a separate action for complex needs.

Breaking Changes Risk

Major version updates, such as V5's switch to node24, can break existing workflows if runners aren't updated, requiring manual intervention and testing.

Frequently Asked Questions

Related Projects

actions/setup-node: Node.js

Set up your GitHub Actions workflow with a specific version of node.js

Stars4,898

Forks1,704

Last commit2 days ago

actions/setup-python: Python

Set up your GitHub Actions workflow with a specific version of Python

Stars2,181

Forks728

Last commit4 days ago

actions/setup-go: Go

Set up your GitHub Actions workflow with a specific version of Go

Stars1,734

Forks666

Last commit3 days ago

actions/setup-dotnet: .NET core sdk

Set up your GitHub Actions workflow with a specific version of the .NET core sdk

Stars1,189

Forks568

Last commit1 day ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub