Skip to content

Commit cdc5f29

Browse files
committed
Fix cross-refernces
1 parent b80173a commit cdc5f29

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

README.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,24 @@ This action allows you to work with Java and Scala projects.
2222

2323
## Usage
2424

25-
Inputs `java-version` and `distribution` are mandatory. See [Supported distributions](#supported-distributions) section for a list of available options.
26-
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.
25+
- `java-version`: _(required)_ The Java version to set up. Takes a whole or [semver](#supported-version-syntax) Java version.
3026

31-
- `distribution`: _(required)_ Java distribution. See the list of supported distributions.
27+
- `distribution`: _(required)_ Java [distribution](#supported-distributions).
3228

33-
- `java-package`: The packaging variant of the choosen distribution. Possible values: `jdk`, `jre`, `jdk+fx`, `jre+fx`.
34-
Default value: `jdk`
29+
- `java-package`: The packaging variant of the choosen distribution. Possible values: `jdk`, `jre`, `jdk+fx`, `jre+fx`. Default value: `jdk`.
3530

36-
- `architecture`: The target architecture of the package. Possible values: `x86`, `x64`, `armv7`, `aarch64`, `ppc64le`.
37-
Default value: `x64`
31+
- `architecture`: The target architecture of the package. Possible values: `x86`, `x64`, `armv7`, `aarch64`, `ppc64le`. Default value: `x64`.
3832

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
33+
- `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.
4034

41-
- `check-latest`: Setting this option makes the action to check for the latest available version for the version spec
35+
- `check-latest`: Setting this option makes the action to check for the latest available version for the version spec.
4236

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 ...
37+
- `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".
4438

4539
#### Maven options
40+
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.
4641

47-
In order to do not store sensetive information in the repository there is set of options to generate maven settings.xml file.
42+
- `overwrite-settings`: By default action overwrites the settings.xml. In order to skip generation of file if it exists set this to `false`.
4843

4944
- `server-id`: ID of the distributionManagement repository in the pom.xml file. Default is `github`.
5045

@@ -54,8 +49,6 @@ Inputs `java-version` and `distribution` are mandatory. See [Supported distribut
5449

5550
- `settings-path`: Maven related setting to point to the diractory where the settings.xml file will be written. Default is ~/.m2.
5651

57-
- `overwrite-settings`: Maven related setting to make to overwrite the settings.xml file if it exists. Default is "true".
58-
5952
- `gpg-private-key`: GPG private key to import. Default is empty string.'
6053

6154
- `gpg-passphrase`: description: 'Environment variable name for the GPG private key passphrase. Default is GPG_PASSPHRASE.
@@ -233,4 +226,4 @@ The scripts and documentation in this project are released under the [MIT Licens
233226

234227
## Contributions
235228

236-
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
229+
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)

0 commit comments

Comments
 (0)