1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00

Minor improvements to gctsCreateRepository step docu and metadata (#1469)

* fix docu

* enhanced step docu and metadata

* regenerate after changing metadata

* small wording change

Co-authored-by: Marcus Holl <marcus.holl@sap.com>
This commit is contained in:
Chris Bo 2020-04-29 16:21:55 +02:00 committed by GitHub
parent 363f69da29
commit 6c32df0b89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 6 deletions

View File

@ -50,6 +50,8 @@ func GctsCreateRepositoryCommand() *cobra.Command {
if err != nil {
return err
}
log.RegisterSecret(stepConfig.Username)
log.RegisterSecret(stepConfig.Password)
return nil
},
Run: func(cmd *cobra.Command, args []string) {

View File

@ -5,7 +5,7 @@
## Prerequisites
With this step you can create a local git-enabled CTS (gCTS) repository on an ABAP server.
Learn more about gCTS [here](https://help.sap.com/viewer/4a368c163b08418890a406d413933ba7/201909.001/en-US/f319b168e87e42149e25e13c08d002b9.html).
Learn more about the SAP git-enabled Central Transport Sytem (gCTS) [here](https://help.sap.com/viewer/4a368c163b08418890a406d413933ba7/201909.001/en-US/f319b168e87e42149e25e13c08d002b9.html). With gCTS, ABAP developments on ABAP servers can be maintained in Git repositories.
## ${docGenParameters}
@ -15,14 +15,14 @@ Learn more about gCTS [here](https://help.sap.com/viewer/4a368c163b08418890a406d
## Example
Example configuration for the use in a Jenkinsfile.
Example configuration for the use in a `Jenkinsfile`.
```groovy
gctsCreateRepository(
script: this,
host: "abap.server.com:port",
host: "https://abap.server.com:port",
client: "000",
credentialsId: 'ABAPUserPasswordCredentialsId',
abapCredentialsId: 'ABAPUserPasswordCredentialsId',
repository: "myrepo",
remoteRepositoryURL: "https://github.com/user/myrepo",
role: "SOURCE",
@ -30,13 +30,13 @@ gctsCreateRepository(
)
```
Example configuration for the use in a yaml config file (such as `.pipeline/config.yaml`).
Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
```yaml
steps:
<...>
gctsCreateRepository:
host: "abap.server.com:port"
host: "https://abap.server.com:port"
client: "000"
username: "ABAPUsername"
password: "ABAPPassword"

View File

@ -19,6 +19,7 @@ spec:
- STAGES
- STEPS
mandatory: true
secret: true
- name: password
type: string
description: Password to authenticate to the ABAP system
@ -27,6 +28,7 @@ spec:
- STAGES
- STEPS
mandatory: true
secret: true
- name: repository
type: string
description: Specifies the name (ID) of the local repository on the ABAP system
@ -65,6 +67,9 @@ spec:
- PARAMETERS
- STAGES
- STEPS
possibleValues:
- SOURCE
- TARGET
- name: vSID
type: string
description: Virtual SID of the local repository. The vSID corresponds to the transport route that delivers content to the remote Git repository