Pkldoc > com.github.action > com.github.action.actions.Setup

JavaInputs0.0.7

Properties
Methods

class JavaInputs

Known subtypes:
Known usages:
All versions:

Properties

link

`java-version`: String?

The Java version that is going to be set up.

Takes a whole or semver Java version. If not specified, the action will expect java-version-file input to be specified
link
`java-version-file`: String?

The path to a file containing java version.
If the java-version-file input is specified, the action will extract the version from the file and install it.

Supported files are .java-version and .tool-versions. In .java-version file, only the version should be specified (e.g., 17.0.7). In .tool-versions file, java version should be preceded by the java keyword (e.g., java 17.0.7). The .java-version file recognizes all variants of the version description according to jenv. Similarly, the .tool-versions file supports version specifications in accordance with asdf standards, adhering to Semantic Versioning (semver).

If both java-version and java-version-file inputs are provided, the java-version input will be used.

Valid entry options:
```
major versions: 8, 11, 16, 17, 21
more specific versions: 8.0.282+8, 8.0.232, 11.0, 11.0.4, 17.0
early access (EA) versions: 15-ea, 15.0.0-ea
versions with specified distribution: openjdk64-11.0.2
```
link

distribution: JavaDistribution

Java distribution
link

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

The packaging variant of the chosen distribution. Possible values: jdk, jre, jdk+fx, jre+fx.

Default value: jdk
link

architecture: ("x86"|"x64"|"armv7"|"aarch64"|"ppc64le")?

The target architecture of the package.

Possible values: x86, x64, armv7, aarch64, ppc64le.

Default value: Derived from the runner machine.
link

jdkFile: String?

If a use-case requires a custom distribution setup-java uses the compressed JDK from the location pointed by this input and will take care of the installation and caching on the VM.
link

`check-latest`: Boolean?

Setting this option makes the action to check for the latest available version for the version spec.
link

`server-id`: String?

ID of the distributionManagement repository in the pom.xml file.

Default is github.
link

`server-username`: String?

Environment variable name for the username for authentication to the Apache Maven repository.

Default is GITHUB_ACTOR.
link

`server-password`: String?

Environment variable name for password or token for authentication to the Apache Maven repository.

Default is GITHUB_TOKEN.
link

`settings-path`: String?

Maven related setting to point to the directory where the settings.xml file will be written.

Default is ~/.m2.
link

`overwrite-settings`: Boolean?

By default action overwrites the settings.xml.

In order to skip generation of file if it exists, set this to false.
link

`gpg-private-key`: String?

GPG private key to import.

Default is empty string.
link

`gpg-passphrase`: String?

Environment variable name for the GPG private key passphrase.

Default is GPG_PASSPHRASE.
link

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

Quick setup caching for the dependencies managed through one of the predefined package managers.

It can be one of "maven", "gradle" or "sbt"
link

`cache-dependency-path`: String?

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?

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

token: String?

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.
link

`mvn-toolchain-id`: String?

Name of Maven Toolchain ID if the default name of ${distribution}_${java-version} is not wanted.
link

`mvn-toolchain-vendor`: String?

Name of Maven Toolchain Vendor if the default name of ${distribution} is not wanted

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.