diff --git a/documentation/bin/createDocu.groovy b/documentation/bin/createDocu.groovy index b8560f8b8..16b66891a 100644 --- a/documentation/bin/createDocu.groovy +++ b/documentation/bin/createDocu.groovy @@ -572,7 +572,7 @@ void renderStep(stepName, stepProperties) { docGenDescription : 'Description\n\n' + stepProperties.description, docGenParameters : 'Parameters\n\n' + TemplateHelper.createParametersSection(stepProperties.parameters), docGenConfiguration : 'Step configuration\n\n' + TemplateHelper.createStepConfigurationSection(stepProperties.parameters), - docDependencies : 'Dependencies (beta)\n\n' + TemplateHelper.createDependencyList(stepProperties.dependencies) + docJenkinsPluginDependencies : 'Dependencies (beta)\n\n' + TemplateHelper.createDependencyList(stepProperties.dependencies) ] def template = new StreamingTemplateEngine().createTemplate(theStepDocu.text) diff --git a/documentation/docs/steps/artifactSetVersion.md b/documentation/docs/steps/artifactSetVersion.md index 0479c65e2..ec97349b7 100644 --- a/documentation/docs/steps/artifactSetVersion.md +++ b/documentation/docs/steps/artifactSetVersion.md @@ -10,7 +10,7 @@ none ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/batsExecuteTests.md b/documentation/docs/steps/batsExecuteTests.md index 8bec79b32..39f5acfac 100644 --- a/documentation/docs/steps/batsExecuteTests.md +++ b/documentation/docs/steps/batsExecuteTests.md @@ -10,7 +10,7 @@ You need to have a Bats test file. By default you would put this into directory ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/checkChangeInDevelopment.md b/documentation/docs/steps/checkChangeInDevelopment.md index ca72f691d..b79406a5b 100644 --- a/documentation/docs/steps/checkChangeInDevelopment.md +++ b/documentation/docs/steps/checkChangeInDevelopment.md @@ -10,7 +10,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/checksPublishResults.md b/documentation/docs/steps/checksPublishResults.md index 276759766..f2e4b8838 100644 --- a/documentation/docs/steps/checksPublishResults.md +++ b/documentation/docs/steps/checksPublishResults.md @@ -82,7 +82,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ### Thresholds diff --git a/documentation/docs/steps/cloudFoundryDeploy.md b/documentation/docs/steps/cloudFoundryDeploy.md index 1d19514c9..5318b37a0 100644 --- a/documentation/docs/steps/cloudFoundryDeploy.md +++ b/documentation/docs/steps/cloudFoundryDeploy.md @@ -13,7 +13,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/containerExecuteStructureTests.md b/documentation/docs/steps/containerExecuteStructureTests.md index 338ece538..8cf4656c0 100644 --- a/documentation/docs/steps/containerExecuteStructureTests.md +++ b/documentation/docs/steps/containerExecuteStructureTests.md @@ -10,7 +10,7 @@ Test configuration is available. ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/detectExecuteScan.md b/documentation/docs/steps/detectExecuteScan.md index 52553642b..aa371fac9 100644 --- a/documentation/docs/steps/detectExecuteScan.md +++ b/documentation/docs/steps/detectExecuteScan.md @@ -9,7 +9,7 @@ You need to store the API token for the Detect service as _'Secret text'_ creden !!! note "minimum plugin requirement" This step requires [synopsys-detect-plugin](https://github.com/jenkinsci/synopsys-detect-plugin) with at least version `2.0.0`. -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/dockerExecute.md b/documentation/docs/steps/dockerExecute.md index 9e3d88f21..d0e3f46e0 100644 --- a/documentation/docs/steps/dockerExecute.md +++ b/documentation/docs/steps/dockerExecute.md @@ -10,7 +10,7 @@ If the Jenkins is setup on a Kubernetes cluster, then you can execute the closur ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/dockerExecuteOnKubernetes.md b/documentation/docs/steps/dockerExecuteOnKubernetes.md index e1d7b443d..b64aaac16 100644 --- a/documentation/docs/steps/dockerExecuteOnKubernetes.md +++ b/documentation/docs/steps/dockerExecuteOnKubernetes.md @@ -13,7 +13,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/durationMeasure.md b/documentation/docs/steps/durationMeasure.md index afae2f189..6427e01bd 100644 --- a/documentation/docs/steps/durationMeasure.md +++ b/documentation/docs/steps/durationMeasure.md @@ -6,7 +6,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/gaugeExecuteTests.md b/documentation/docs/steps/gaugeExecuteTests.md index 2adef1920..162c283d7 100644 --- a/documentation/docs/steps/gaugeExecuteTests.md +++ b/documentation/docs/steps/gaugeExecuteTests.md @@ -12,7 +12,7 @@ none We recommend to define values of step parameters via [config.yml file](../configuration.md). -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/githubPublishRelease.md b/documentation/docs/steps/githubPublishRelease.md index 0fe05cc8c..959e37981 100644 --- a/documentation/docs/steps/githubPublishRelease.md +++ b/documentation/docs/steps/githubPublishRelease.md @@ -6,7 +6,7 @@ You need to create a personal access token within GitHub and add this to the Jen Please see [GitHub documentation for details about creating the personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## ${docGenParameters} diff --git a/documentation/docs/steps/handlePipelineStepErrors.md b/documentation/docs/steps/handlePipelineStepErrors.md index 18f90fb37..84f4d6f3b 100644 --- a/documentation/docs/steps/handlePipelineStepErrors.md +++ b/documentation/docs/steps/handlePipelineStepErrors.md @@ -10,7 +10,7 @@ none ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/healthExecuteCheck.md b/documentation/docs/steps/healthExecuteCheck.md index 9df27328d..896f02b43 100644 --- a/documentation/docs/steps/healthExecuteCheck.md +++ b/documentation/docs/steps/healthExecuteCheck.md @@ -16,7 +16,7 @@ Endpoint for health check is configured. ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/influxWriteData.md b/documentation/docs/steps/influxWriteData.md index c5c74ff5c..c5a6af5ef 100644 --- a/documentation/docs/steps/influxWriteData.md +++ b/documentation/docs/steps/influxWriteData.md @@ -67,7 +67,7 @@ influxDBServer=jenkins ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/kanikoExecute.md b/documentation/docs/steps/kanikoExecute.md index 7f48a7580..f098cb2ce 100644 --- a/documentation/docs/steps/kanikoExecute.md +++ b/documentation/docs/steps/kanikoExecute.md @@ -16,7 +16,7 @@ via _Jenkins_ -> _Credentials_ -> _System_ -> _Global credentials (unrestricted) * File: upload your `config.json` file * ID: specify id which you then use for the configuration of `dockerConfigJsonCredentialsId` (see below) -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/karmaExecuteTests.md b/documentation/docs/steps/karmaExecuteTests.md index fc0e60ebc..e30764461 100644 --- a/documentation/docs/steps/karmaExecuteTests.md +++ b/documentation/docs/steps/karmaExecuteTests.md @@ -7,7 +7,7 @@ * **running Karma tests** - have a NPM module with running tests executed with Karma * **configured WebDriver** - have the [`karma-webdriver-launcher`](https://github.com/karma-runner/karma-webdriver-launcher) package installed and a custom, WebDriver-based browser configured in Karma -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## ${docGenParameters} diff --git a/documentation/docs/steps/mailSendNotification.md b/documentation/docs/steps/mailSendNotification.md index b5f2cac32..5405b5aca 100644 --- a/documentation/docs/steps/mailSendNotification.md +++ b/documentation/docs/steps/mailSendNotification.md @@ -18,7 +18,7 @@ mailSendNotification script: this ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/mavenExecute.md b/documentation/docs/steps/mavenExecute.md index b87488475..ab8438cc1 100644 --- a/documentation/docs/steps/mavenExecute.md +++ b/documentation/docs/steps/mavenExecute.md @@ -6,7 +6,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/mtaBuild.md b/documentation/docs/steps/mtaBuild.md index 3c73d2ef3..54a4a0f95 100644 --- a/documentation/docs/steps/mtaBuild.md +++ b/documentation/docs/steps/mtaBuild.md @@ -14,7 +14,7 @@ While using a custom docker file, ensure that the following tools are installed: ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/multicloudDeploy.md b/documentation/docs/steps/multicloudDeploy.md index 0f3f70c46..da75e47a6 100644 --- a/documentation/docs/steps/multicloudDeploy.md +++ b/documentation/docs/steps/multicloudDeploy.md @@ -1,12 +1,12 @@ # ${docGenStepName} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## ${docGenParameters} ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Examples diff --git a/documentation/docs/steps/neoDeploy.md b/documentation/docs/steps/neoDeploy.md index 836aa9571..70f8a4cb6 100644 --- a/documentation/docs/steps/neoDeploy.md +++ b/documentation/docs/steps/neoDeploy.md @@ -18,7 +18,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/newmanExecute.md b/documentation/docs/steps/newmanExecute.md index 67dd65a0c..e744d5df4 100644 --- a/documentation/docs/steps/newmanExecute.md +++ b/documentation/docs/steps/newmanExecute.md @@ -14,7 +14,7 @@ Step uses `dockerExecute` inside. -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/npmExecute.md b/documentation/docs/steps/npmExecute.md index b9f0856e6..fb17c70ee 100644 --- a/documentation/docs/steps/npmExecute.md +++ b/documentation/docs/steps/npmExecute.md @@ -1,13 +1,13 @@ # ${docGenStepName} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## ${docGenParameters} ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/pipelineExecute.md b/documentation/docs/steps/pipelineExecute.md index 580584ded..68d474ea9 100644 --- a/documentation/docs/steps/pipelineExecute.md +++ b/documentation/docs/steps/pipelineExecute.md @@ -10,7 +10,7 @@ none ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/pipelineRestartSteps.md b/documentation/docs/steps/pipelineRestartSteps.md index fe31237b0..dbe8b5749 100644 --- a/documentation/docs/steps/pipelineRestartSteps.md +++ b/documentation/docs/steps/pipelineRestartSteps.md @@ -31,7 +31,7 @@ pipelineRestartSteps (script: this) { none -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/pipelineStashFiles.md b/documentation/docs/steps/pipelineStashFiles.md index 70a17d02a..1c2a690e5 100644 --- a/documentation/docs/steps/pipelineStashFiles.md +++ b/documentation/docs/steps/pipelineStashFiles.md @@ -34,7 +34,7 @@ The step is stashing files before and after the build. This is due to the fact, ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Explanation of pipeline step diff --git a/documentation/docs/steps/pipelineStashFilesAfterBuild.md b/documentation/docs/steps/pipelineStashFilesAfterBuild.md index 251204aed..114ac9d0e 100644 --- a/documentation/docs/steps/pipelineStashFilesAfterBuild.md +++ b/documentation/docs/steps/pipelineStashFilesAfterBuild.md @@ -4,11 +4,11 @@ none -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## ${docGenParameters} ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} diff --git a/documentation/docs/steps/pipelineStashFilesBeforeBuild.md b/documentation/docs/steps/pipelineStashFilesBeforeBuild.md index 09b294d8a..c6cf93df4 100644 --- a/documentation/docs/steps/pipelineStashFilesBeforeBuild.md +++ b/documentation/docs/steps/pipelineStashFilesBeforeBuild.md @@ -10,5 +10,5 @@ none ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} diff --git a/documentation/docs/steps/piperPipelineStagePost.md b/documentation/docs/steps/piperPipelineStagePost.md index 4b8162443..3d8f3171a 100644 --- a/documentation/docs/steps/piperPipelineStagePost.md +++ b/documentation/docs/steps/piperPipelineStagePost.md @@ -6,4 +6,4 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} diff --git a/documentation/docs/steps/prepareDefaultValues.md b/documentation/docs/steps/prepareDefaultValues.md index 8b4c76258..552c96065 100644 --- a/documentation/docs/steps/prepareDefaultValues.md +++ b/documentation/docs/steps/prepareDefaultValues.md @@ -10,7 +10,7 @@ None -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/seleniumExecuteTests.md b/documentation/docs/steps/seleniumExecuteTests.md index 21539026c..b6070d962 100644 --- a/documentation/docs/steps/seleniumExecuteTests.md +++ b/documentation/docs/steps/seleniumExecuteTests.md @@ -68,7 +68,7 @@ webdriverio ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/setupCommonPipelineEnvironment.md b/documentation/docs/steps/setupCommonPipelineEnvironment.md index 4c437659c..aa32b3216 100644 --- a/documentation/docs/steps/setupCommonPipelineEnvironment.md +++ b/documentation/docs/steps/setupCommonPipelineEnvironment.md @@ -10,7 +10,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/slackSendNotification.md b/documentation/docs/steps/slackSendNotification.md index 40c851382..6aaa5ec2d 100644 --- a/documentation/docs/steps/slackSendNotification.md +++ b/documentation/docs/steps/slackSendNotification.md @@ -12,7 +12,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Example diff --git a/documentation/docs/steps/snykExecute.md b/documentation/docs/steps/snykExecute.md index 2bd1e1994..239fda8ac 100644 --- a/documentation/docs/steps/snykExecute.md +++ b/documentation/docs/steps/snykExecute.md @@ -11,7 +11,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/sonarExecuteScan.md b/documentation/docs/steps/sonarExecuteScan.md index 22f064225..968f2a6be 100644 --- a/documentation/docs/steps/sonarExecuteScan.md +++ b/documentation/docs/steps/sonarExecuteScan.md @@ -11,7 +11,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/testsPublishResults.md b/documentation/docs/steps/testsPublishResults.md index 54b6c5f5c..a614a5ac4 100644 --- a/documentation/docs/steps/testsPublishResults.md +++ b/documentation/docs/steps/testsPublishResults.md @@ -79,7 +79,7 @@ testsPublishResults( ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Side effects diff --git a/documentation/docs/steps/transportRequestCreate.md b/documentation/docs/steps/transportRequestCreate.md index ec72d5c80..bcd69d0b1 100644 --- a/documentation/docs/steps/transportRequestCreate.md +++ b/documentation/docs/steps/transportRequestCreate.md @@ -11,7 +11,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} The step is configured using a customer configuration file provided as resource in an custom shared library. diff --git a/documentation/docs/steps/transportRequestRelease.md b/documentation/docs/steps/transportRequestRelease.md index 7434c6979..d38b95b0f 100644 --- a/documentation/docs/steps/transportRequestRelease.md +++ b/documentation/docs/steps/transportRequestRelease.md @@ -10,7 +10,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} The step is configured using a customer configuration file provided as resource in an custom shared library. diff --git a/documentation/docs/steps/transportRequestUploadFile.md b/documentation/docs/steps/transportRequestUploadFile.md index 331444d09..63b9ac7cb 100644 --- a/documentation/docs/steps/transportRequestUploadFile.md +++ b/documentation/docs/steps/transportRequestUploadFile.md @@ -10,7 +10,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} The step is configured using a customer configuration file provided as resource in an custom shared library. diff --git a/documentation/docs/steps/uiVeri5ExecuteTests.md b/documentation/docs/steps/uiVeri5ExecuteTests.md index 2f27d4621..24942174e 100644 --- a/documentation/docs/steps/uiVeri5ExecuteTests.md +++ b/documentation/docs/steps/uiVeri5ExecuteTests.md @@ -8,7 +8,7 @@ ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions diff --git a/documentation/docs/steps/whitesourceExecuteScan.md b/documentation/docs/steps/whitesourceExecuteScan.md index 40889e75c..6255c72dc 100644 --- a/documentation/docs/steps/whitesourceExecuteScan.md +++ b/documentation/docs/steps/whitesourceExecuteScan.md @@ -12,7 +12,7 @@ access protection imposed on the WhiteSource backend would simply allow access b ## ${docGenConfiguration} -## ${docDependencies} +## ${docJenkinsPluginDependencies} ## Exceptions