Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.setup-java.v5.SetupJava

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

`java-version`: String?Source

The Java version to set up. Takes a whole or semver Java version. See examples of supported syntax in README file
link

`java-version-file`: String?Source

The path to the .java-version file. See examples of supported syntax in README file
link

distribution: "adopt"|"adopt-hotspot"|"adopt-openj9"|"corretto"|"liberica"|"microsoft"|"temurin"|"zulu"Source

Java distribution. See the list of supported distributions in README file
link

`java-package`: ("jdk"|"jre"|"jdk+fx"|"jre+fx")?Source

The package type (jdk, jre, jdk+fx, jre+fx)

Default if unspecified: "jdk"
link

architecture: String?Source

The architecture of the package (defaults to the action runner's architecture)
link

jdkFile: String?Source

Path to where the compressed JDK is located
link

`check-latest`: Boolean?Source

Set this option if you want the action to check for the latest available version that satisfies the version spec

Default if unspecified: false
link

`server-id`: String?Source

ID of the distributionManagement repository in the pom.xml file. Default is github

Default if unspecified: "github"
link

`server-username`: String?Source

Environment variable name for the username for authentication to the Apache Maven repository. Default is $GITHUB_ACTOR

Default if unspecified: "GITHUB_ACTOR"
link

`server-password`: String?Source

Environment variable name for password or token for authentication to the Apache Maven repository. Default is $GITHUB_TOKEN

Default if unspecified: "GITHUB_TOKEN"
link

`settings-path`: String?Source

Path to where the settings.xml file will be written. Default is ~/.m2.
link

`overwrite-settings`: Boolean?Source

Overwrite the settings.xml file if it exists. Default is "true".

Default if unspecified: true
link

`gpg-private-key`: String?Source

GPG private key to import. Default is empty string.
link

`gpg-passphrase`: String?Source

Environment variable name for the GPG private key passphrase. Default is $GPG_PASSPHRASE.
link

cache: ("maven"|"gradle"|"sbt")?Source

Name of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt".
link

`cache-dependency-path`: String?Source

The path to a dependency file: pom.xml, build.gradle, build.sbt, etc. This option can be used with the cache option. If this option is omitted, the action searches for the dependency file in the entire repository. This option supports wildcards and a list of file names for caching multiple dependencies.
link

`job-status`: String?Source

Workaround to pass job status to post job step. This variable is not intended for manual setting

Default if unspecified: "${{ job.status }}"
link

token: String?Source

The token used to authenticate when fetching version manifests hosted on github.com, such as for the Microsoft Build of OpenJDK. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting.

Default if unspecified: "${{ github.server_url == 'https://github.com' && github.token || '' }}"
link

`mvn-toolchain-id`: String?Source

Name of Maven Toolchain ID if the default name of "${distribution}_${java-version}" is not wanted. See examples of supported syntax in Advanced Usage file
link

`mvn-toolchain-vendor`: String?Source

Name of Maven Toolchain Vendor if the default name of "${distribution}" is not wanted. See examples of supported syntax in Advanced Usage file

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.