You've already forked sap-jenkins-library
mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-11-29 22:58:09 +02:00
Introduce label for Jenkins plugin dependencies
This commit is contained in:
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
You need to have a Bats test file. By default you would put this into directory `src/test` within your source code repository.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -13,6 +13,8 @@
|
||||
* [warnings](https://plugins.jenkins.io/warnings)
|
||||
* [core](https://plugins.jenkins.io/core)
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
### aggregation
|
||||
|
||||
@@ -9,6 +9,8 @@
|
||||
|
||||

|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
Test configuration is available.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -9,6 +9,8 @@ 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}
|
||||
|
||||
## Example
|
||||
|
||||
```groovy
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## Kubernetes support
|
||||
|
||||
@@ -9,6 +9,8 @@
|
||||
|
||||

|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -8,6 +8,8 @@ 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}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -12,6 +12,8 @@ Endpoint for health check is configured.
|
||||
!!! tip
|
||||
If using Spring Boot framework, ideally the provided `/health` endpoint is used and extended by development. Further information can be found in the [Spring Boot documenation for Endpoints](http://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html)
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
### Setting up InfluxDB with Grafana
|
||||
|
||||
The easiest way to start with is using the available official docker images.
|
||||
|
||||
@@ -16,6 +16,8 @@ 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}
|
||||
|
||||
## Example
|
||||
|
||||
```groovy
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
* **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}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
Usage of pipeline step:
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -10,6 +10,8 @@ While using a custom docker file, ensure that the following tools are installed:
|
||||
* **Java 8 or compatible version** - necessary to run the *MTA Archive Builder* itself and to build Java modules.
|
||||
* **NodeJS installed** - the MTA Builder uses `npm` to download node module dependencies such as `grunt`.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -16,6 +16,8 @@
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
* prepared Postman with a test collection
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
Details:
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
## ${docGenDescription}
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
none
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## Example
|
||||
|
||||
```groovy
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
* A **configuration file** with properties. The property values are used as default values in many pipeline steps.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -8,6 +8,8 @@
|
||||
* *secret text* Jenkins credentials with the Slack token
|
||||
* Installed and configured [Jenkins Slack plugin](https://github.com/jenkinsci/slack-plugin#install-instructions-for-slack).
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
* **Snyk account** - have an account on snyk.io
|
||||
* **Snyk token** - have a Snyk user token
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
- The project needs a `sonar-project.properties` file that describes the project and defines certain settings, see [here](https://docs.sonarqube.org/display/SCAN/Advanced+SonarQube+Scanner+Usages#AdvancedSonarQubeScannerUsages-Multi-moduleProjectStructure).
|
||||
- A SonarQube instance needs to be defined in the Jenkins.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -11,6 +11,8 @@
|
||||
* [cobertura](https://plugins.jenkins.io/cobertura)
|
||||
* [performance](https://plugins.jenkins.io/performance)
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## Pipeline configuration
|
||||
|
||||
none
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
|
||||
* Solution Manager version `ST720 SP08` or newer.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -6,6 +6,8 @@
|
||||
|
||||
* **[Change Management Client 2.0.0 or compatible version](http://central.maven.org/maven2/com/sap/devops/cmclient/dist.cli/)** - available for download on Maven Central.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
@@ -8,6 +8,8 @@ Your company has registered an account with WhiteSource and you have enabled the
|
||||
access to your organization in WhiteSource via dedicated privileges. Scanning your products without adequate user level
|
||||
access protection imposed on the WhiteSource backend would simply allow access based on the organization token.
|
||||
|
||||
## ${docDependencies}
|
||||
|
||||
## ${docGenParameters}
|
||||
|
||||
## ${docGenConfiguration}
|
||||
|
||||
Reference in New Issue
Block a user