Add a toolchain only - control update of settings.xml, toolchains.xml, JAVA_HOME and PATH more granular #553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhoffrog
changed the title
mhoffrog
force-pushed
the
mhoffrog/552_allow_to_add_a_toolchain_only
branch
2 times, most recently
from
1c8123d
to
e7b1371
Compare
|
@IvanZosimov is there anything I can do in addition to get this PR merged? |
mhoffrog
force-pushed
the
mhoffrog/552_allow_to_add_a_toolchain_only
branch
2 times, most recently
from
3f983c4
to
230bb6e
Compare
|
@IvanZosimov PR branch is re-based to current main and dist scripts did pass |
mhoffrog
force-pushed
the
mhoffrog/552_allow_to_add_a_toolchain_only
branch
from
230bb6e
to
598ae60
Compare
|
@IvanZosimov PR branch is re-based to current main and dist scripts did pass Check dist action. |
…nv-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}`
- missed in initial commit - took re-built dist from GH actions
mhoffrog
force-pushed
the
mhoffrog/552_allow_to_add_a_toolchain_only
branch
from
b8f4969
to
993bbb6
Compare
|
@mahabaleshwars @IvanZosimov FYI - PR branch is re-based to current main and dist scripts did pass action |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
09-Nov-2023: Amended commit comments only.
Description:
The following input items have been added (copied from README.md update):
update-env-javahome: By default action updatesenv.JAVA_HOMEwith the path of java installed. In order to skip update of JAVA_HOME, set this tofalse. The creation of the env variable JAVA_HOME_{{ MAJOR_VERSION }}_{{ ARCHITECTURE }} is NOT affected by this item. That will be created for any setup.update-env-path: By default action adds<java_install_dir>/bintoenv.PATH. In order to skip this, set this tofalse.update-toolchains-only: If set to true, thenoverwrite-settings,update-env-javahomeandupdate-env-pathare propagated tofalseif the specific one is not explicitly configured totrue. Only a toolchain entry will be added to toolchains.xml. Default isfalse.Summary on a few code improvements (Inserted by 09-Nov-2023):
By that implementation I did a few code improvements as follows:
setup-java.ts:overwrite-settings- plus the ones I did add - are read now once only in a single code place (withinsetup-java.tsonly) to a constant and pass their effective values either by method parameters or by object fields to other places during the runtime lifecycletoolchains.tsFurther particular details on the code changes can be taken from my commit comment b0dadd2.
Related issue:
#552
Check list:
💡 Documentation has been updated by this PR