mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00

Improved documentation for gctsDeploy (#3054 )

* Changed documentation for gctsDeploy

* Changes gctsDeploy readme and yaml file

Co-authored-by: Martin Bredy <58846699+martin-bredy@users.noreply.github.com>
Co-authored-by: Thorsten Duda <thorsten.duda@sap.com>

2021-08-20 12:54:55 +02:00

1.8 KiB

Raw Blame History

${docGenStepName}

${docGenDescription}

Prerequisites

If you provide a commit ID, the step deploys the content of the specified commit to the ABAP system. If you provide a branch, the step deploys the content of the specified branch. If you set the rollback parameter to true, the step returns to a working state of the repository, if the deployment of the specified commit or branch fails. Learn more about the SAP Git-enabled Change & Transport System (gCTS) here. With gCTS, ABAP developments on ABAP servers can be maintained in Git repositories.

${docGenParameters}

${docGenConfiguration}

${docJenkinsPluginDependencies}

Example

Example configuration for the use in a Jenkinsfile.

gctsDeploy(
  script: this,
  host: 'https://abap.server.com:port',
  client: '000',
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
  repository: 'myrepo',
  remoteRepositoryURL: "https://remote.repository.url.com",
  role: 'SOURCE',
  vSID: 'ABC',
  branch: 'feature1',
  commit: '95952ec',
  scope: 'LASTACTION',
  rollback: true,
  configuration: [VCS_AUTOMATIC_PULL: 'FALSE',VCS_AUTOMATIC_PUSH: 'FALSE',CLIENT_VCS_LOGLVL: 'debug']
)

Example for the use in a YAML configuration file (such as .pipeline/config.yaml).

steps:
  <...>
  gctsDeploy:
    host: 'https://abap.server.com:port'
    client: '000'
    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
    repository: 'myrepo'
    remoteRepositoryURL: "https://remote.repository.url.com"
    role: 'SOURCE'
    vSID: 'ABC'
    branch: 'feature2'
    commit: '0c9d330'
    scope: 'CRNTCOMMIT'
    rollback: false
    configuration:
        VCS_AUTOMATIC_PULL: "FALSE"
        VCS_AUTOMATIC_PUSH: "FALSE"
        CLIENT_VCS_LOGLVL: "debug"

1.8 KiB Raw Blame History