2019-11-08 16:40:12 +00:00
name : 'Setup Java JDK'
2019-12-06 19:35:32 +00:00
description : 'Set up a specific version of the Java JDK and add the
command-line tools to the PATH'
2019-07-10 14:54:25 +00:00
author : 'GitHub'
2019-12-06 19:36:32 +00:00
inputs :
2019-08-13 20:24:39 +00:00
java-version :
2021-04-05 10:02:27 +00:00
description : 'The Java version to set up. Takes a whole or semver Java version. See examples of supported syntax in README file'
2022-12-13 11:45:14 +00:00
java-version-file :
description : 'The path to the `.java-version` file. See examples of supported syntax in README file'
2021-04-05 10:02:27 +00:00
distribution :
description : 'Java distribution. See the list of supported distributions in README file'
2019-07-11 03:11:48 +00:00
required : true
2019-11-22 20:32:49 +00:00
java-package :
2021-04-05 10:02:27 +00:00
description : 'The package type (jdk, jre, jdk+fx, jre+fx)'
2019-11-22 18:45:27 +00:00
required : false
2019-11-03 04:39:35 +00:00
default : 'jdk'
2019-11-22 20:32:49 +00:00
architecture :
2022-10-10 23:47:17 +00:00
description : "The architecture of the package (defaults to the action runner's architecture)"
2019-11-22 18:45:27 +00:00
required : false
2019-07-11 03:11:48 +00:00
jdkFile :
2021-04-05 10:02:27 +00:00
description : 'Path to where the compressed JDK is located'
required : false
check-latest :
description : 'Set this option if you want the action to check for the latest available version that satisfies the version spec'
2019-07-15 15:26:32 +00:00
required : false
2021-04-05 10:02:27 +00:00
default : false
2019-11-28 22:18:30 +00:00
server-id :
2019-12-06 19:35:32 +00:00
description : 'ID of the distributionManagement repository in the pom.xml
2019-12-20 16:35:06 +00:00
file. Default is `github`'
2019-11-28 22:18:30 +00:00
required : false
2020-07-16 01:53:39 +00:00
default : 'github'
2019-12-19 16:52:26 +00:00
server-username :
2019-12-19 19:28:11 +00:00
description : 'Environment variable name for the username for authentication
2019-12-20 16:35:06 +00:00
to the Apache Maven repository. Default is $GITHUB_ACTOR'
2019-11-28 22:18:30 +00:00
required : false
2020-07-16 01:53:39 +00:00
default : 'GITHUB_ACTOR'
2019-12-19 16:52:26 +00:00
server-password :
2019-12-19 19:28:11 +00:00
description : 'Environment variable name for password or token for
2019-12-20 16:35:06 +00:00
authentication to the Apache Maven repository. Default is $GITHUB_TOKEN'
2019-11-28 22:18:30 +00:00
required : false
2020-07-16 01:53:39 +00:00
default : 'GITHUB_TOKEN'
2019-12-10 21:02:21 +00:00
settings-path :
2019-12-18 19:05:01 +00:00
description : 'Path to where the settings.xml file will be written. Default is ~/.m2.'
2019-12-10 21:02:21 +00:00
required : false
2021-04-05 10:02:27 +00:00
overwrite-settings :
Add inputs 'update-toolchains-only', 'update-env-javahome', 'add-to-env-path'
Changes in detail:
------------------
- action.yml:
- add inputs:
- update-toolchains-only
- update-env-javahome
- add-to-env-path
- update description for input "overwrite-settings"
- remove default value of input "overwrite-settings",
since the default is now propagated from input 'update-toolchains-only'
- base-models.ts:
- extend interface JavaInstallerOptions:
- add fields:
- updateEnvJavaHome: boolean;
- addToEnvPath: boolean;
- constants.ts:
- add constant INPUT_UPDATE_TOOLCHAINS_ONLY
= 'update-toolchains-only'
- auth.ts:
- function configureAuthentication():
- add parameter:
- overwriteSettings: boolean
- remove the now obsolete const overwriteSettings
- toolchains.ts:
- function configureToolchains(...):
- add parameter updateToolchains: boolean
- remove the now obsolete const overwriteSettings
- improve variable naming:
- rename any occurrence of 'overwriteSettings'
by 'updateToolchains'
- add field updateToolchains: boolean to the parameter object
- function writeToolchainsFileToDisk(...):
- improve variable naming:
- rename variable 'settingsExists'
by 'toolchainsExists'
- update wording of info logs to be more applicable
- setup-java.ts:
- interface installerInputsOptions:
- rename to IInstallerInputsOption to meet common coding convention
- add fields:
- updateToolchainsOnly: boolean;
- overwriteSettings: boolean;
- updateEnvJavaHome: boolean;
- addToEnvPath: boolean;
- function run():
- add const:
- const updateToolchainsOnly:
- get as boolean from input 'update-toolchains-only', default: false
- const overwriteSettings:
- get as boolean from input 'overwrite-settings', default: !updateToolchainsOnly
- const updateEnvJavaHome:
- get as boolean input 'update-env-javahome', default: !updateToolchainsOnly
- const addToEnvPath:
- get as boolean input 'add-to-env-path', default: !updateToolchainsOnly
- extend const installerInputsOptions to match with IInstallerInputsOption:
- add field updateToolchainsOnly
- add field overwriteSettings
- add field updateEnvJavaHome
- add field addToEnvPath
- update call of auth.configureAuthentication()
to auth.configureAuthentication(overwriteSettings)
- function installVersion(...):
- add const and init from parameter options:
- updateToolchainsOnly, overwriteSettings,
updateEnvJavaHome, addToEnvPath
- init the additional fields of installerInputsOptions accordingly
- call toolchains.configureToolchains(...):
- with parameter updateToolchains= overwriteSettings || updateToolchainsOnly
- base-installer.ts:
- add constants to import from constants:
- INPUT_UPDATE_JAVA_HOME
- INPUT_ADD_TO_PATH
- add fields:
- protected updateEnvJavaHome: boolean;
- protected addToEnvPath: boolean;
- ctor:
- init these fields from JavaInstallerOptions accoprdingly
- function setJavaDefault(...):
- if updateEnvJavaHome is false:
- SKIP updating env.JAVA_HOME
- log info:
`Skip updating env.JAVA_HOME according to ${INPUT_UPDATE_JAVA_HOME}`
- if addToEnvPath is false:
- SKIP adding toolchain path to env.PATH
- log info:
`Skip adding to env.PATH according to ${INPUT_ADD_TO_PATH}`
2023-11-06 23:27:36 +00:00
description : 'Overwrite the settings.xml file if it exists. Default is "!update-toolchains-only". If explcitly set "true", it will update settings.xml regardless of "update-toolchains-only"'
2021-04-05 10:02:27 +00:00
required : false
Add inputs 'update-toolchains-only', 'update-env-javahome', 'add-to-env-path'
Changes in detail:
------------------
- action.yml:
- add inputs:
- update-toolchains-only
- update-env-javahome
- add-to-env-path
- update description for input "overwrite-settings"
- remove default value of input "overwrite-settings",
since the default is now propagated from input 'update-toolchains-only'
- base-models.ts:
- extend interface JavaInstallerOptions:
- add fields:
- updateEnvJavaHome: boolean;
- addToEnvPath: boolean;
- constants.ts:
- add constant INPUT_UPDATE_TOOLCHAINS_ONLY
= 'update-toolchains-only'
- auth.ts:
- function configureAuthentication():
- add parameter:
- overwriteSettings: boolean
- remove the now obsolete const overwriteSettings
- toolchains.ts:
- function configureToolchains(...):
- add parameter updateToolchains: boolean
- remove the now obsolete const overwriteSettings
- improve variable naming:
- rename any occurrence of 'overwriteSettings'
by 'updateToolchains'
- add field updateToolchains: boolean to the parameter object
- function writeToolchainsFileToDisk(...):
- improve variable naming:
- rename variable 'settingsExists'
by 'toolchainsExists'
- update wording of info logs to be more applicable
- setup-java.ts:
- interface installerInputsOptions:
- rename to IInstallerInputsOption to meet common coding convention
- add fields:
- updateToolchainsOnly: boolean;
- overwriteSettings: boolean;
- updateEnvJavaHome: boolean;
- addToEnvPath: boolean;
- function run():
- add const:
- const updateToolchainsOnly:
- get as boolean from input 'update-toolchains-only', default: false
- const overwriteSettings:
- get as boolean from input 'overwrite-settings', default: !updateToolchainsOnly
- const updateEnvJavaHome:
- get as boolean input 'update-env-javahome', default: !updateToolchainsOnly
- const addToEnvPath:
- get as boolean input 'add-to-env-path', default: !updateToolchainsOnly
- extend const installerInputsOptions to match with IInstallerInputsOption:
- add field updateToolchainsOnly
- add field overwriteSettings
- add field updateEnvJavaHome
- add field addToEnvPath
- update call of auth.configureAuthentication()
to auth.configureAuthentication(overwriteSettings)
- function installVersion(...):
- add const and init from parameter options:
- updateToolchainsOnly, overwriteSettings,
updateEnvJavaHome, addToEnvPath
- init the additional fields of installerInputsOptions accordingly
- call toolchains.configureToolchains(...):
- with parameter updateToolchains= overwriteSettings || updateToolchainsOnly
- base-installer.ts:
- add constants to import from constants:
- INPUT_UPDATE_JAVA_HOME
- INPUT_ADD_TO_PATH
- add fields:
- protected updateEnvJavaHome: boolean;
- protected addToEnvPath: boolean;
- ctor:
- init these fields from JavaInstallerOptions accoprdingly
- function setJavaDefault(...):
- if updateEnvJavaHome is false:
- SKIP updating env.JAVA_HOME
- log info:
`Skip updating env.JAVA_HOME according to ${INPUT_UPDATE_JAVA_HOME}`
- if addToEnvPath is false:
- SKIP adding toolchain path to env.PATH
- log info:
`Skip adding to env.PATH according to ${INPUT_ADD_TO_PATH}`
2023-11-06 23:27:36 +00:00
# DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
update-toolchains-only :
description : 'Update toolchains.xml only. Default is "false". No update of settings.xml, no update of JAVA_HOME, no adding to PATH by default - unless "overwrite-settings", "update-env-javahome" or "add-to-env-path" are not explicitly set "true"'
required : false
default : false
update-env-javahome :
description : 'Update the JAVA_HOME environment variable. Default is "!update-toolchains-only"'
required : false
# DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
add-to-env-path :
description : 'Add "<JDK home>/bin" to the PATH environment variable. Default is "!update-toolchains-only"'
required : false
# DO NOT set a default here! The default will be propagated from input 'update-toolchains-only'!
2020-05-02 11:33:15 +00:00
gpg-private-key :
description : 'GPG private key to import. Default is empty string.'
required : false
gpg-passphrase :
description : 'Environment variable name for the GPG private key passphrase. Default is
$GPG_PASSPHRASE.'
required : false
2021-08-19 17:19:35 +00:00
cache :
2022-06-16 20:47:05 +00:00
description : 'Name of the build platform to cache dependencies. It can be "maven", "gradle" or "sbt".'
2021-08-19 17:19:35 +00:00
required : false
2023-11-22 15:43:14 +00:00
cache-dependency-path :
description: '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.'
required : false
2021-08-19 17:19:35 +00:00
job-status :
description : 'Workaround to pass job status to post job step. This variable is not intended for manual setting'
default : ${{ job.status }}
2022-09-23 12:47:30 +00:00
token :
2022-11-18 08:33:59 +00:00
description : 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 : ${{ github.server_url == 'https://github.com' && github.token || '' }}
2022-01-16 16:33:29 +00:00
mvn-toolchain-id :
description : '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'
required : false
mvn-toolchain-vendor :
description : 'Name of Maven Toolchain Vendor if the default name of "${distribution}" is not wanted. See examples of supported syntax in Advanced Usage file'
required : false
2020-05-24 18:03:57 +00:00
outputs :
2021-04-05 10:02:27 +00:00
distribution :
description : 'Distribution of Java that has been installed'
2020-05-24 18:03:57 +00:00
version :
description : 'Actual version of the java environment that has been installed'
2021-04-05 10:02:27 +00:00
path :
description : 'Path to where the java environment has been installed (same as $JAVA_HOME)'
2022-09-07 10:34:51 +00:00
cache-hit :
description : 'A boolean value to indicate an exact match was found for the primary key'
2019-07-10 14:54:25 +00:00
runs :
2023-11-29 14:11:46 +00:00
using : 'node20'
2020-05-02 11:33:15 +00:00
main : 'dist/setup/index.js'
post : 'dist/cleanup/index.js'
