diff --git a/README.md b/README.md index 460c5cf3b..904521da4 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,36 @@ This action allows you to work with Java and Scala projects. ## Usage -Inputs `java-version` and `distribution` are mandatory. See [Supported distributions](#supported-distributions) section for a list of available options. + - `java-version`: _(required)_ The Java version to set up. Takes a whole or [semver](#supported-version-syntax) Java version. + + - `distribution`: _(required)_ Java [distribution](#supported-distributions). + + - `java-package`: The packaging variant of the choosen distribution. Possible values: `jdk`, `jre`, `jdk+fx`, `jre+fx`. Default value: `jdk`. + + - `architecture`: The target architecture of the package. Possible values: `x86`, `x64`, `armv7`, `aarch64`, `ppc64le`. Default value: `x64`. + + - `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. + + - `check-latest`: Setting this option makes the action to check for the latest available version for the version spec. + + - `cache`: Quick [setup caching](#caching-packages-dependencies) for the dependencies managed through one of the predifined package managers. It can be one of "maven", "gradle" or "sbt". + + #### Maven options + The action has a bunch of inputs to generate maven's [settings.xml](https://maven.apache.org/settings.html) on the fly and pass the values to Apache Maven GPG Plugin. See [advanced usage](docs/advanced-usage.md) for more. + + - `overwrite-settings`: By default action overwrites the settings.xml. In order to skip generation of file if it exists set this to `false`. + + - `server-id`: ID of the distributionManagement repository in the pom.xml file. Default is `github`. + + - `server-username`: Environment variable name for the username for authentication to the Apache Maven repository. Default is GITHUB_ACTOR. + + - `server-password`: Environment variable name for password or token for authentication to the Apache Maven repository. Default is GITHUB_TOKEN. + + - `settings-path`: Maven related setting to point to the diractory where the settings.xml file will be written. Default is ~/.m2. + + - `gpg-private-key`: GPG private key to import. Default is empty string.' + + - `gpg-passphrase`: description: 'Environment variable name for the GPG private key passphrase. Default is GPG_PASSPHRASE. ### Basic Configuration @@ -197,4 +226,4 @@ The scripts and documentation in this project are released under the [MIT Licens ## Contributions -Contributions are welcome! See [Contributor's Guide](docs/contributors.md) \ No newline at end of file +Contributions are welcome! See [Contributor's Guide](docs/contributors.md)