Skip to content

Commit b80173a

Browse files
committed
Add inputs documentation to README
1 parent a96c2ca commit b80173a

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,42 @@ This action allows you to work with Java and Scala projects.
2424

2525
Inputs `java-version` and `distribution` are mandatory. See [Supported distributions](#supported-distributions) section for a list of available options.
2626

27+
### Inputs reference
28+
29+
- `java-version`: _(required)_ The Java version to set up. Takes a whole or semver Java version. See examples of supported syntax.
30+
31+
- `distribution`: _(required)_ Java distribution. See the list of supported distributions.
32+
33+
- `java-package`: The packaging variant of the choosen distribution. Possible values: `jdk`, `jre`, `jdk+fx`, `jre+fx`.
34+
Default value: `jdk`
35+
36+
- `architecture`: The target architecture of the package. Possible values: `x86`, `x64`, `armv7`, `aarch64`, `ppc64le`.
37+
Default value: `x64`
38+
39+
- `jdkFile`: 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
40+
41+
- `check-latest`: Setting this option makes the action to check for the latest available version for the version spec
42+
43+
`cache`: Quick setup caching for the dependencies managed through one of the predifined package managers. It can be on of "maven", "gradle" or "sbt". See ...
44+
45+
#### Maven options
46+
47+
In order to do not store sensetive information in the repository there is set of options to generate maven settings.xml file.
48+
49+
- `server-id`: ID of the distributionManagement repository in the pom.xml file. Default is `github`.
50+
51+
- `server-username`: Environment variable name for the username for authentication to the Apache Maven repository. Default is GITHUB_ACTOR.
52+
53+
- `server-password`: Environment variable name for password or token for authentication to the Apache Maven repository. Default is GITHUB_TOKEN.
54+
55+
- `settings-path`: Maven related setting to point to the diractory where the settings.xml file will be written. Default is ~/.m2.
56+
57+
- `overwrite-settings`: Maven related setting to make to overwrite the settings.xml file if it exists. Default is "true".
58+
59+
- `gpg-private-key`: GPG private key to import. Default is empty string.'
60+
61+
- `gpg-passphrase`: description: 'Environment variable name for the GPG private key passphrase. Default is GPG_PASSPHRASE.
62+
2763
### Basic Configuration
2864

2965
#### Eclipse Temurin

0 commit comments

Comments
 (0)