Project Piper

https://www.project-piper.io
Admin
Project Piper is SAP's continuous delivery and integration tooling solution providing predefined...
Tokens:187,660
Snippets:3,379
Trust Score:6.2
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example Configuration YAML

Source: https://www.project-piper.io/steps/transportRequestRelease

Example content for a configuration file located in the shared library resources.

```yaml
general:
  changeManagement:
    changeDocumentLabel: 'ChangeDocument\s?:'
    cmClientOpts: '-Djavax.net.ssl.trustStore=<path to truststore>'
    credentialsId: 'CM'
    type: 'SOLMAN'
    endpoint: 'https://example.org/cm'
    git:
      from: 'HEAD~1'
      to: 'HEAD'
      format: '%b'
```

--------------------------------

### Basic MavenExecute Example

Source: https://www.project-piper.io/steps/mavenExecute

A simple example demonstrating the basic usage of the MavenExecute step with 'goals'.

```groovy
mavenExecute script: this, goals: ['clean', 'install']

```

--------------------------------

### Complete config.yml Example

Source: https://www.project-piper.io/steps/abapEnvironmentBuild

A comprehensive example of the config.yml file, demonstrating various parameters including certificate names, phase, values, download/publish filenames, and runtime settings. Note that 'values' is a JSON string.

```yaml
stages:
  MyPhase:
    abapCredentialsId: 'abapCredentialsId'
    host: 'https://myABAPendpoint.com'
    certificateNames: ['myCert.cer']
    phase: 'MyPhase'
    values: '[{"value_id":"ID1","value":"Value1"},{"value_id":"ID2","value":"Value2"}]'
    downloadResultFilenames: ['File1','File2']
    publishResultFilenames: ['File2']
    subDirectoryForDownload: 'MyDir'
    filenamePrefixForDownload: 'MyPrefix'
    treatWarningsAsError: true
    maxRuntimeInMinutes: 360
    pollingIntervallInSeconds: 15


```

--------------------------------

### Build Stage Configuration Example (config.yml)

Source: https://www.project-piper.io/pipelines/abapEnvironment/stages/build

This configuration example shows how to set up the Build stage in a `config.yml` file. It includes general settings and specific configurations for the Build stage, such as Cloud Foundry credentials and service key details.

```yaml
general:
  abapAddonAssemblyKitCredentialsId: 'TechUserAAKaaS'
  addonDescriptorFileName: 'addon.yml'
  cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
  cfOrg: 'myOrgBld'
  cfSpace: 'mySpaceBld'
  cfCredentialsId: 'cfAuthentification'
  cfServiceInstance: 'bld_system'
  cfServiceKeyName: 'JENKINS_SAP_COM_0948'
stages:
  Build:
    cfServiceKeyName: 'JENKINS_SAP_COM_0582'
    cfServiceKeyConfig: 'sap_com_0582.json'

```

--------------------------------

### Command Line Usage

Source: https://www.project-piper.io/steps/nexusUpload

Example of executing the nexusUpload step directly from the command line.

```bash
piper nexusUpload
```

--------------------------------

### Invoke kanikoExecute via Command Line

Source: https://www.project-piper.io/steps/kanikoExecute

Example of calling the step from the command line.

```bash
piper kanikoExecute
```

--------------------------------

### Jenkinsfile Configuration for apiProviderList

Source: https://www.project-piper.io/steps/apiProviderList

Example of how to configure the apiProviderList step within a Jenkinsfile.

```groovy
apiProviderList script: this
```

--------------------------------

### Configure Environment Variables

Source: https://www.project-piper.io/steps/batsExecuteTests

Example format for injecting environment variables into the step execution.

```text
['CONTAINER_NAME=piper-jenskins','IMAGE_NAME=my-image']
```

--------------------------------

### Command Line Usage of apiProviderUpload

Source: https://www.project-piper.io/steps/apiProviderUpload

Example of how to execute the apiProviderUpload step directly from the command line.

```bash
piper apiProviderUpload
```

--------------------------------

### Per-step Configuration Example

Source: https://www.project-piper.io/steps/transportRequestUploadFile

Override change management settings specifically for the transportRequestUploadFile step.

```yaml
  [...]
  steps:
    transportRequestUploadFile:
      applicationId: 'FOO'
      changeManagement:
        type: 'SOLMAN'
        endpoint: 'https://example.org/cm'
        [...]
```

--------------------------------

### Configure multipleImages for kanikoExecute

Source: https://www.project-piper.io/steps/kanikoExecute

Example configuration for building multiple images using sub-contexts with kanikoExecute.

```yaml
containerRegistryUrl: docker.io
containerImageTag: latest
multipleImages:
- containerImageName: myImage1
  containerImageTag: v1.0.0
  contextSubPath: path/to/folder
```

--------------------------------

### Call xsDeploy from Command Line

Source: https://www.project-piper.io/steps/xsDeploy

Example of how to execute the xsDeploy step directly from the command line.

```bash
piper xsDeploy

```

--------------------------------

### Call artifactPrepareVersion via Command Line

Source: https://www.project-piper.io/steps/artifactPrepareVersion

Example of invoking the step directly from the command line.

```bash
piper artifactPrepareVersion
```

--------------------------------

### Basic Jenkinsfile Setup

Source: https://www.project-piper.io/stages/examples

This is the minimal required code for a Jenkinsfile when using the piper-lib library.

```groovy
@Library('piper-lib') _

piperPipeline script: this

```

--------------------------------

### Call integrationArtifactUpdateConfiguration on Command Line

Source: https://www.project-piper.io/steps/integrationArtifactUpdateConfiguration

Example of executing the integrationArtifactUpdateConfiguration step directly from the command line.

```bash
piper integrationArtifactUpdateConfiguration
```

--------------------------------

### Execute abapEnvironmentRunAUnitTest

Source: https://www.project-piper.io/steps/abapEnvironmentRunAUnitTest

Examples of invoking the step via Jenkins library or command line interface.

```groovy
library('piper-lib-os')

abapEnvironmentRunAUnitTest script: this
```

```bash
piper abapEnvironmentRunAUnitTest
```

--------------------------------

### Create Pull Request using Command Line

Source: https://www.project-piper.io/steps/githubCreatePullRequest

Example of how to execute the githubCreatePullRequest step directly from the command line. This assumes the piper CLI is installed and configured.

```bash
piper githubCreatePullRequest

```

--------------------------------

### Configuration Example for Prepare System Stage

Source: https://www.project-piper.io/pipelines/abapEnvironment/stages/prepareSystem

This YAML configuration demonstrates how to set up the 'Prepare System' stage, including general Cloud Foundry settings and specific ABAP system parameters.

```yaml
general:
  cfApiEndpoint: 'https://api.cf.sap.hana.ondemand.com'
  cfOrg: 'myOrg'
  cfSpace: 'mySpace'
  cfCredentialsId: 'cfAuthentification'
  cfServiceInstance: 'abap_system'
stages:
  Prepare System:
    cfService: 'abap'
    cfServicePlan: 'standard'
    abapSystemAdminEmail: 'user@example.com'
    abapSystemDescription: 'ABAP Environment Q System'
    abapSystemIsDevelopmentAllowed: false
    abapSystemID: 'H02'
    abapSystemSizeOfPersistence: 4
    abapSystemSizeOfRuntime: 1

```

--------------------------------

### Configure Git Commit Range in Pipeline Configuration

Source: https://www.project-piper.io/steps/transportRequestDocIDFromGit

Example of how to configure the 'gitFrom' parameter in a pipeline configuration file to specify the starting point for the Git commit scan.

```yaml
steps:
  transportRequestDocIDFromGit:
    gitFrom: '4378bb4'
```

--------------------------------

### Create Pull Request using Jenkins Library

Source: https://www.project-piper.io/steps/githubCreatePullRequest

Example of how to call the githubCreatePullRequest step within a Jenkins pipeline using the piper-lib-os library. Ensure the library is correctly installed and accessible.

```groovy
library('piper-lib-os')

githubCreatePullRequest script: this

```

--------------------------------

### Configure Git Commit Range using gitFrom

Source: https://www.project-piper.io/steps/transportRequestReqIDFromGit

Example of configuring the gitFrom parameter to specify a starting commit hash for the Git log scan, useful for retrieving IDs from the main branch history.

```yaml
steps:
  transportRequestReqIDFromGit:
    gitFrom: '4378bb4'
```

--------------------------------

### Deploy Integration Artifact via Command Line

Source: https://www.project-piper.io/steps/integrationArtifactDeploy

Example of how to execute the integrationArtifactDeploy step from the command line.

```bash
piper integrationArtifactDeploy
```

--------------------------------

### Simple npmExecuteTests Example

Source: https://www.project-piper.io/steps/npmExecuteTests

A basic configuration to run wdi5 tests using npmExecuteTests with a specified baseUrl.

```yaml
stages:
  - name: Test
    steps:
      - name: npmExecuteTests
        type: npmExecuteTests
        params:
          baseUrl: "http://example.com/index.html"
```

--------------------------------

### InfluxDB Query Examples

Source: https://www.project-piper.io/steps/influxWriteData

Example queries for retrieving build metrics and step data from InfluxDB for use in Grafana dashboards.

```sql
select top(build_number,10), build_result from jenkins_data WHERE build_result = 'SUCCESS'
```

```sql
select top(build_number,10), build_result, build_step from jenkins_custom_data WHERE build_result = 'FAILURE'
```

```sql
select build_duration / 1000 from "pipeline_data" WHERE project_name='PiperTestOrg_piper_test_master'
```

```sql
select top(build_number,10) AS "Build", build_url, build_quality, fortify, gauge, vulas, opa from step_data WHERE project_name='PiperTestOrg_piper_test_master'
```

--------------------------------

### Gauge Execute Tests Example

Source: https://www.project-piper.io/steps/gaugeExecuteTests

Example of how to use the gaugeExecuteTests step in a pipeline. This snippet demonstrates setting the test server URL.

```groovy
gaugeExecuteTests script: this, testServerUrl: 'http://test.url'
```

--------------------------------

### gctsRollback YAML Configuration Example

Source: https://www.project-piper.io/steps/gctsRollback

Example configuration for the gctsRollback step in a YAML file, typically used in a .pipeline/config.yaml. This format is common for pipeline configurations.

```yaml
steps:
  <...>
  gctsRollback:
    host: "https://abap.server.com:port"
    client: "000"
    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
    repository: "myrepo"
```

--------------------------------

### gctsRollback Jenkinsfile Example

Source: https://www.project-piper.io/steps/gctsRollback

Example configuration for the gctsRollback step within a Jenkinsfile. Ensure 'script', 'host', 'client', 'abapCredentialsId', and 'repository' are correctly set.

```groovy
gctsRollback(
  script: this,
  host: "https://abap.server.com:port",
  client: "000",
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
  repository: "myrepo"
  )
```

--------------------------------

### Command Line API Proxy Upload

Source: https://www.project-piper.io/steps/apiProxyUpload

Example of how to execute the apiProxyUpload step directly from the command line.

```bash
piper apiProxyUpload
```

--------------------------------

### Publish Stage Configuration Example (config.yml)

Source: https://www.project-piper.io/pipelines/abapEnvironment/stages/publish

This snippet shows the configuration for the Publish stage in `config.yml`. It includes credentials and the add-on descriptor file name, along with stage-specific settings like `targetVectorScope`.

```yaml
general:
  abapAddonAssemblyKitCredentialsId: 'TechUserAAKaaS'
  addonDescriptorFileName: 'addon.yml'
stages:
  Publish:
    targetVectorScope: 'P'

```

--------------------------------

### AUnit Configuration File

Source: https://www.project-piper.io/pipelines/abapEnvironment/stages/test

Example `aUnitConfig.yml` for configuring AUnit tests. This example specifies testing complete software components and includes options for scope, risk level, and duration.

```yaml
title: My AUnit run
context: AUnit test run
options:
  measurements: none
  scope:
    ownTests: true
    foreignTests: true
  riskLevel:
    harmless: true
    dangerous: true
    critical: true
  duration:
    short: true
    medium: true
    long: true
objectSet:
  softwarecomponents:
  - name: Z_TEST_SC
  - name: Z_TEST_SC2
```

--------------------------------

### Basic cfManifestSubstituteVariables Usage

Source: https://www.project-piper.io/steps/cfManifestSubstituteVariables

Demonstrates the standard configuration for the step including optional manifest file paths and variable files.

```groovy
cfManifestSubstituteVariables (
  script: this,
  manifestFile: "path/to/manifest.yml",                      //optional, default: manifest.yml
  manifestVariablesFiles: ["path/to/manifest-variables.yml"] //optional, default: ['manifest-variables.yml']
  manifestVariables: [[key : value], [key : value]]          //optional, default: []
)
```

--------------------------------

### Example Usage of azureBlobUpload in Jenkinsfile

Source: https://www.project-piper.io/steps/azureBlobUpload

This example shows a complete call to the azureBlobUpload step within a Jenkinsfile, specifying the script context, Azure credentials ID, and the file path to upload.

```groovy
azureBlobUpload(
    script: this,
    azureCredentialsId: "Azure_Credentials",
    filePath: "test.txt"
)
```

--------------------------------

### Example Console Output for Errors

Source: https://www.project-piper.io/steps/handlePipelineStepErrors

This example shows the detailed console output generated by `handlePipelineStepErrors` when `echoDetails` is set to true and an error occurs. It includes step information, available parameters, and the specific error message.

```text
----------------------------------------------------------
--- An error occurred in the library step: ${stepName}
----------------------------------------------------------
The following parameters were available to the step:
***
${stepParameters}
***
The error was:
***
${err}
***
Further information:
* Documentation of step ${stepName}: .../${stepName}/
* Pipeline documentation: https://...
* GitHub repository for pipeline steps: https://...
----------------------------------------------------------


```

--------------------------------

### Invoke kanikoExecute in Jenkins

Source: https://www.project-piper.io/steps/kanikoExecute

Example of calling the step within a Jenkins pipeline.

```groovy
library('piper-lib-os')

kanikoExecute script: this
```

--------------------------------

### Configure ldflagsTemplate

Source: https://www.project-piper.io/steps/golangBuild

Examples of using commonPipelineEnvironment parameters within the ldflags template.

```text
* `-X github.com/SAP/jenkins-library/pkg/log.Version={{index .CPE "artifactVersion"}}`.
* `-X github.com/SAP/jenkins-library/pkg/log.LibraryRepository={{index .CPE "custom/repositoryId"}}`
```

--------------------------------

### Individual Configuration for abapAddonAssemblyKitCheck

Source: https://www.project-piper.io/steps/abapAddonAssemblyKitCheck

This example shows how to configure the `abapAddonAssemblyKitCheck` step individually within the `config.yml` file. It specifies credentials and the addon descriptor file name.

```yaml
steps:
  abapAddonAssemblyKitCheck:
    abapAddonAssemblyKitCredentialsId: 'abapAddonAssemblyKitCredentialsId',
    addonDescriptorFileName: 'addon.yml'

```

--------------------------------

### Execute abapEnvironmentCheckoutBranch in Jenkins and CLI

Source: https://www.project-piper.io/steps/abapEnvironmentCheckoutBranch

Shows how to invoke the step using a Jenkins library or the command line interface.

```groovy
library('piper-lib-os')

abapEnvironmentCheckoutBranch script: this
```

```bash
piper abapEnvironmentCheckoutBranch
```

--------------------------------

### Execute Container Structure Tests (Command Line)

Source: https://www.project-piper.io/steps/containerExecuteStructureTests

Example of executing the containerExecuteStructureTests step from the command line.

```bash
piper containerExecuteStructureTests
```

--------------------------------

### Call transportRequestUploadRFC on Command Line

Source: https://www.project-piper.io/steps/transportRequestUploadRFC

Example of how to execute the transportRequestUploadRFC step from the command line.

```bash
piper transportRequestUploadRFC
```

--------------------------------

### Call transportRequestReqIDFromGit on Command Line

Source: https://www.project-piper.io/steps/transportRequestReqIDFromGit

Example of executing the transportRequestReqIDFromGit step from the command line.

```bash
piper transportRequestReqIDFromGit
```

--------------------------------

### Create Transport Request Examples

Source: https://www.project-piper.io/steps/transportRequestCreate

Demonstrates how to create transport requests for SOLMAN and CTS change management systems.

```Groovy
// SOLMAN
def transportRequestId = transportRequestCreate script:this,
                                                changeDocumentId: '001,'
                                                changeManagement: [
                                                  type: 'SOLMAN'
                                                  endpoint: 'https://example.org/cm'
                                                ]
// CTS
def transportRequestId = transportRequestCreate script:this,
                                                transportType: 'W',
                                                targetSystem: 'XYZ',
                                                description: 'the description',
                                                changeManagement: [
                                                  type: 'CTS'
                                                  endpoint: 'https://example.org/cm'
                                                ]
```

--------------------------------

### Invoke hadolintExecute

Source: https://www.project-piper.io/steps/hadolintExecute

Examples for running the linter in Jenkins or via the command line interface.

```groovy
library('piper-lib-os')

hadolintExecute script: this
```

```bash
piper hadolintExecute
```

--------------------------------

### xsDeploy Step Usage

Source: https://www.project-piper.io/steps/xsDeploy

Example of how to use the xsDeploy step within a script. Ensure all required parameters are provided.

```groovy
xsDeploy
    script: this,
    mtaPath: 'path/to/archiveFile.mtar',
    credentialsId: 'my-credentials-id',
    apiUrl: 'https://example.org/xs',
    space: 'mySpace',
    org: 'myOrg'

```

--------------------------------

### Deploy Helm chart with kubernetesDeploy

Source: https://www.project-piper.io/steps/kubernetesDeploy

Example of deploying a specific Helm chart using Helm 3 with registry and image configuration.

```groovy
// Deploy a helm chart called "myChart" using Helm 3
kubernetesDeploy script: this, deployTool: 'helm3', chartPath: 'myChart', deploymentName: 'myRelease', image: 'nginx', containerRegistryUrl: 'https://docker.io'
```

--------------------------------

### Command Line Usage for helmExecute

Source: https://www.project-piper.io/steps/helmExecute

Shows how to execute the helmExecute step directly from the command line.

```bash
piper helmExecute

```

--------------------------------

### ATC Configuration with Software Components Only

Source: https://www.project-piper.io/steps/abapEnvironmentRunATCCheck

Example of an atcconfig.yml file restricted to software components.

```yaml
objectset:
  softwarecomponents:
    - name: TestComponent
    - name: TestComponent2
```

--------------------------------

### ATC Configuration with Packages Only

Source: https://www.project-piper.io/steps/abapEnvironmentRunATCCheck

Example of an atcconfig.yml file restricted to packages and package trees.

```yaml
objectset:
  packages:
    - name: TestPackage
  packagetrees:
    - name: TestPackageWithSubpackages
```

--------------------------------

### Deploy Integration Artifact in Jenkinsfile

Source: https://www.project-piper.io/steps/integrationArtifactDeploy

Example of how to call the integrationArtifactDeploy step within a Jenkinsfile.

```groovy
integrationArtifactDeploy script: this
```

--------------------------------

### Basic neoDeploy script configuration

Source: https://www.project-piper.io/steps/neoDeploy

Example of a basic neoDeploy script call with credentials and host parameters.

```groovy
neoDeploy script: this, source: 'path/to/archiveFile.mtar', neo: [credentialsId: 'my-credentials-id', host: hana.example.org]
```

--------------------------------

### Call artifactPrepareVersion in Jenkins

Source: https://www.project-piper.io/steps/artifactPrepareVersion

Example of invoking the step within a Jenkins pipeline library.

```groovy
library('piper-lib-os')

artifactPrepareVersion script: this
```

--------------------------------

### Execute golangBuild in Jenkins and Command Line

Source: https://www.project-piper.io/steps/golangBuild

Examples for invoking the golangBuild step within a Jenkins pipeline library or via the Piper CLI.

```groovy
library('piper-lib-os')

golangBuild script: this
```

```bash
piper golangBuild
```

--------------------------------

### Configure isChangeInDevelopment in config.yml

Source: https://www.project-piper.io/steps/checkChangeInDevelopment

Example configuration for the new step replacing the deprecated checkChangeInDevelopment.

```yaml
general:

# new naming convention
steps:
  isChangeInDevelopment:
    dockerImage: 'ppiper/cm-client:3.0.0.0'
```
Tokens:
Raw