sap-jenkins-library/documentation/docs/steps/abapEnvironmentPullGitRepo.md

${docGenStepName}

${docGenDescription}

Prerequisites

A SAP BTP, ABAP environment system is available. On this system, a Communication User, a Communication System and a Communication Arrangement is setup for the Communication Scenario "SAP BTP, ABAP Environment - Software Component Test Integration (SAP_COM_0510)". This can be done manually through the respective applications on the SAP BTP, ABAP environment system or through creating a service key for the system on Cloud Foundry with the parameters {"scenario_id": "SAP_COM_0510", "type": "basic"}. In a pipeline, you can do this with the step cloudFoundryCreateServiceKey.

${docGenParameters}

${docGenConfiguration}

${docJenkinsPluginDependencies}

Example: Configuration in the config.yml

The recommended way to configure your pipeline is via the config.yml file. In this case, calling the step in the Jenkinsfile is reduced to one line:

abapEnvironmentPullGitRepo script: this

If you want to provide the host and credentials of the Communication Arrangement directly, the configuration could look as follows:

steps:
  abapEnvironmentPullGitRepo:
    repositoryNames: ['/DMO/GIT_REPOSITORY']
    abapCredentialsId: 'abapCredentialsId'
    host: '1234-abcd-5678-efgh-ijk.abap.eu10.hana.ondemand.com'

However, we recommend to use a dedicated file, e.g. repositories.yml to specify the repositories to be pulled:

steps:
  abapEnvironmentPullGitRepo:
    repositories: 'repositories.yml'
    abapCredentialsId: 'abapCredentialsId'
    host: '1234-abcd-5678-efgh-ijk.abap.eu10.hana.ondemand.com'

The associated config file, e.g. repositories.yml could look as follows:

repositories:
- name: '/DMO/GIT_REPOSITORY'
  branch: 'master'
- name: '/DMO/GIT_REPO'
  branch: 'master'
  commitID: 'cd87a3cac2bc946b7629580e58598c3db56a26f8'

It is optional to provide a branch. However, if you also want to use this file for the abapEnvironmentCheckoutBranch step it is recommended to follow the above structure. If you want to pull a specific commit, the commitID can be specified optionally for a repository.

If you want to read the host and credentials from the cloud foundry service key of the respective instance, the configuration could look as follows:

steps:
  abapEnvironmentPullGitRepo:
    repositoryNames: ['/DMO/GIT_REPOSITORY']
    cfCredentialsId: 'cfCredentialsId'
    cfApiEndpoint: 'https://test.server.com'
    cfOrg: 'cfOrg'
    cfSpace: 'cfSpace'
    cfServiceInstance: 'cfServiceInstance'
    cfServiceKeyName: 'cfServiceKeyName'

Example: Configuration in the Jenkinsfile

It is also possible to call the steps - including all parameters - directly in the Jenkinsfile. In the first example, the host and the credentialsId of the Communication Arrangement are directly provided.

abapEnvironmentPullGitRepo (
  script: this,
  repositoryNames: ['/DMO/GIT_REPOSITORY'],
  abapCredentialsId: 'abapCredentialsId',
  host: '1234-abcd-5678-efgh-ijk.abap.eu10.hana.ondemand.com'
)

In the second example, the host and credentialsId will be read from the provided Cloud Foundry service key of the specified service instance.

abapEnvironmentPullGitRepo (
  script: this,
  repositoryNames: ['/DMO/GIT_REPOSITORY', '/DMO/GIT_REPO'],
  abapCredentialsId: 'cfCredentialsId',
  cfApiEndpoint: 'https://test.server.com',
  cfOrg: 'cfOrg',
  cfSpace: 'cfSpace',
  cfServiceInstance: 'cfServiceInstance',
  cfServiceKeyName: 'cfServiceKeyName'
)