mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-03-03 15:02:35 +02:00
More speaking name in doc wrt jenkins plugin deps
This commit is contained in:
parent
ca4e756317
commit
fcc470271c
@ -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)
|
||||
|
@ -10,7 +10,7 @@ none
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -10,7 +10,7 @@ You need to have a Bats test file. By default you would put this into directory
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -82,7 +82,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
### Thresholds
|
||||
|
||||
|
@ -13,7 +13,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -10,7 +10,7 @@ Test configuration is available.
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -10,7 +10,7 @@ If the Jenkins is setup on a Kubernetes cluster, then you can execute the closur
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -13,7 +13,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -12,7 +12,7 @@ none
|
||||
|
||||
We recommend to define values of step parameters via [config.yml file](../configuration.md).
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -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}
|
||||
|
||||
|
@ -10,7 +10,7 @@ none
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -16,7 +16,7 @@ Endpoint for health check is configured.
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -67,7 +67,7 @@ influxDBServer=jenkins
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -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}
|
||||
|
||||
|
@ -18,7 +18,7 @@ mailSendNotification script: this
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -6,7 +6,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -14,7 +14,7 @@ While using a custom docker file, ensure that the following tools are installed:
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -1,12 +1,12 @@
|
||||
# ${docGenStepName}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Examples
|
||||
|
||||
|
@ -18,7 +18,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -14,7 +14,7 @@
|
||||
|
||||
Step uses `dockerExecute` inside.
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -1,13 +1,13 @@
|
||||
|
||||
# ${docGenStepName}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -10,7 +10,7 @@ none
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -31,7 +31,7 @@ pipelineRestartSteps (script: this) {
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -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
|
||||
|
||||
|
@ -4,11 +4,11 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
|
@ -10,5 +10,5 @@ none
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
|
@ -6,4 +6,4 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
None
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -68,7 +68,7 @@ webdriverio
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -12,7 +12,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -11,7 +11,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -11,7 +11,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -79,7 +79,7 @@ testsPublishResults(
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Side effects
|
||||
|
||||
|
@ -11,7 +11,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
The step is configured using a customer configuration file provided as
|
||||
resource in an custom shared library.
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
The step is configured using a customer configuration file provided as
|
||||
resource in an custom shared library.
|
||||
|
@ -10,7 +10,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
The step is configured using a customer configuration file provided as
|
||||
resource in an custom shared library.
|
||||
|
@ -8,7 +8,7 @@
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
@ -12,7 +12,7 @@ access protection imposed on the WhiteSource backend would simply allow access b
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
## ${docDependencies}
|
||||
## ${docJenkinsPluginDependencies}
|
||||
|
||||
## Exceptions
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user