Arguments available to the org.zowe.jenkins_shared_library.pipelines.nodejs.NodeJSPipeline#setup(org.zowe.jenkins_shared_library.pipelines.nodejs.arguments.NodeJSSetupArguments) method.
Fields inherited from class | Fields |
---|---|
class org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments |
__$stMC, __$stMC, __$stMC |
class org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments |
__$stMC, __$stMC |
Type | Name and description |
---|---|
java.lang.Boolean |
alwaysUseNpmInstall If we always use npm install , never use npm ci . |
org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout |
audit Amount of time allowed to audit. |
java.lang.Boolean |
auditWithColor If we want to display colorful output of audit stage |
java.lang.Boolean |
disableAudit If we disable the default audit stage |
java.lang.Boolean |
disableLint If we disable the default lint stage |
java.lang.Boolean |
exitIfFolderNotClean If exit the pipeline if the git folder is not clean after install dependencies. |
java.lang.Boolean |
ignoreAuditFailure If continue the pipeline if npm audit failed. |
org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout |
installDependencies Amount of time allowed to install dependencies. |
java.util.List<java.util.Map> |
installRegistries npm install registry configurations |
org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout |
lint Amount of time allowed to lint. |
java.lang.Boolean |
lintWithColor If we want to display colorful output of lint stage |
java.lang.String |
nodeJsVersion If we want to use another version of node.js. |
java.lang.String |
nvmInitScript Path to nvm.sh. |
java.util.Map |
publishRegistry npm publish registry configurations |
Methods inherited from class | Name |
---|---|
class org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments |
org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getGithub(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setGithub(java.util.Map), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getGithubTagPrefix(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setGithubTagPrefix(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getArtifactory(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setArtifactory(java.util.Map), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getPax(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setPax(java.util.Map), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#super$3$$getStaticMetaClass(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getInitForGeneric(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setInitForGeneric(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDisableGithub(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDisableGithub(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDisableArtifactory(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDisableArtifactory(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDisablePax(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDisablePax(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getExtraInit(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setExtraInit(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getInitWithColor(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setInitWithColor(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setCiSkip(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setOperation(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getCiSkip(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getOperation(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setManifest(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getManifest(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#super$2$$getStaticMetaClass(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getSetup(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setSetup(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getCheckout(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setCheckout(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getSkipCheckout(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setSkipCheckout(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#super$2$setBaseDirectory(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#super$2$getBaseDirectory(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setVersion(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setPackageName(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setBaseDirectory(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getVersion(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getBaseDirectory(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getPackageName(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getIsSkippable(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#isIsSkippable(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDoesIgnoreSkipAll(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#isDoesIgnoreSkipAll(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDoesIgnoreSkipAll(boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setIsSkippable(boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getResultThreshold(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setResultThreshold(org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getShouldExecute(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setShouldExecute(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setStage(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDisplayTimestamp(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#isDisplayTimestamp(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDisplayTimestamp(boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getDisplayAnsiColor(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#isDisplayAnsiColor(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setDisplayAnsiColor(boolean), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getEnvironment(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setEnvironment(java.util.Map), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setTimeout(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getStage(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getTimeout(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#invokeMethod(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getMetaClass(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setMetaClass(groovy.lang.MetaClass), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setProperty(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getProperty(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getName(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#setName(java.lang.String), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#wait(long, int), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#wait(long), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#wait(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#equals(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#toString(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#hashCode(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#getClass(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#notify(), org.zowe.jenkins_shared_library.pipelines.generic.arguments.GenericSetupStageArguments#notifyAll() |
class org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments |
org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#super$2$$getStaticMetaClass(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getSetup(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setSetup(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getCheckout(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setCheckout(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getSkipCheckout(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setSkipCheckout(java.lang.Boolean), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#super$2$setBaseDirectory(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#super$2$getBaseDirectory(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setVersion(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setPackageName(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setBaseDirectory(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getVersion(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getBaseDirectory(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getPackageName(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getIsSkippable(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#isIsSkippable(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getDoesIgnoreSkipAll(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#isDoesIgnoreSkipAll(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setDoesIgnoreSkipAll(boolean), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setIsSkippable(boolean), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getResultThreshold(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setResultThreshold(org.zowe.jenkins_shared_library.pipelines.base.enums.ResultEnum), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getShouldExecute(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setShouldExecute(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setStage(groovy.lang.Closure), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getDisplayTimestamp(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#isDisplayTimestamp(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setDisplayTimestamp(boolean), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getDisplayAnsiColor(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#isDisplayAnsiColor(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setDisplayAnsiColor(boolean), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getEnvironment(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setEnvironment(java.util.Map), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setTimeout(org.zowe.jenkins_shared_library.pipelines.base.models.StageTimeout), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getStage(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getTimeout(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#invokeMethod(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getMetaClass(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setMetaClass(groovy.lang.MetaClass), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setProperty(java.lang.String, java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getProperty(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getName(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#setName(java.lang.String), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#wait(long, int), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#wait(long), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#wait(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#equals(java.lang.Object), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#toString(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#hashCode(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#getClass(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#notify(), org.zowe.jenkins_shared_library.pipelines.base.arguments.SetupStageArguments#notifyAll() |
If we always use npm install
, never use npm ci
.
By default, with value false, the install dependencies stage will try to decide whether
use npm ci
or npm install
based on existence of package.json
.
false
Amount of time allowed to audit.
If we want to display colorful output of audit stage
false
If we disable the default audit stage
false
If we disable the default lint stage
false
If exit the pipeline if the git folder is not clean after install dependencies.
Usually the failure is caused by mismatched package-lock.json or wrong registry configuration.
Pipeline will always exit if there are changes other than lock files.
false
If continue the pipeline if npm audit failed.
false
Amount of time allowed to install dependencies.
npm install registry configurations
Use configurations defined at Registry.init.
Amount of time allowed to lint.
If we want to display colorful output of lint stage
false
If we want to use another version of node.js.
This requires nvm installed on the build container.
Path to nvm.sh.
npm publish registry configurations
Use configurations defined at Registry.init.