gCTS docu fixes (#1823)

* docu fixes * regenerated * convert double to single quotes * outline placeholders Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * outline placeholders Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * outline placeholders Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * outline placeholders Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> * regenerated Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
2024-12-12 10:55:20 +02:00 · 2020-07-22 10:56:20 +02:00 · 2020-07-22 10:56:20 +02:00 · 6b6d1bc087
commit 6b6d1bc087
parent e09b05b22e
12 changed files with 45 additions and 48 deletions
--- a/cmd/gctsCloneRepository_generated.go
+++ b/cmd/gctsCloneRepository_generated.go
@ -81,7 +81,7 @@ func addGctsCloneRepositoryFlags(cmd *cobra.Command, stepConfig *gctsCloneReposi
 	cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "User to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "Password to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Repository, "repository", os.Getenv("PIPER_repository"), "Specifies the name (ID) of the local repsitory on the ABAP system")
-	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'")
+	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.")
 	cmd.Flags().StringVar(&stepConfig.Client, "client", os.Getenv("PIPER_client"), "Specifies the client of the ABAP system to be adressed")

 	cmd.MarkFlagRequired("username")
--- a/cmd/gctsCreateRepository_generated.go
+++ b/cmd/gctsCreateRepository_generated.go
@ -85,7 +85,7 @@ func addGctsCreateRepositoryFlags(cmd *cobra.Command, stepConfig *gctsCreateRepo
 	cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "Username to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "Password to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Repository, "repository", os.Getenv("PIPER_repository"), "Specifies the name (ID) of the local repository on the ABAP system")
-	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'")
+	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.")
 	cmd.Flags().StringVar(&stepConfig.Client, "client", os.Getenv("PIPER_client"), "Specifies the client of the ABAP system to be adressed")
 	cmd.Flags().StringVar(&stepConfig.RemoteRepositoryURL, "remoteRepositoryURL", os.Getenv("PIPER_remoteRepositoryURL"), "URL of the corresponding remote repository")
 	cmd.Flags().StringVar(&stepConfig.Role, "role", os.Getenv("PIPER_role"), "Role of the local repository. Choose between 'TARGET' and 'SOURCE'. Local repositories with a TARGET role will NOT be able to be the source of code changes")
--- a/cmd/gctsDeploy_generated.go
+++ b/cmd/gctsDeploy_generated.go
@ -82,7 +82,7 @@ func addGctsDeployFlags(cmd *cobra.Command, stepConfig *gctsDeployOptions) {
 	cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "User to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "Password to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Repository, "repository", os.Getenv("PIPER_repository"), "Specifies the name (ID) of the local repsitory on the ABAP system")
-	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'")
+	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.")
 	cmd.Flags().StringVar(&stepConfig.Client, "client", os.Getenv("PIPER_client"), "Specifies the client of the ABAP system to be adressed")
 	cmd.Flags().StringVar(&stepConfig.Commit, "commit", os.Getenv("PIPER_commit"), "Specifies the commit to be deployed")

--- a/cmd/gctsExecuteABAPUnitTests_generated.go
+++ b/cmd/gctsExecuteABAPUnitTests_generated.go
@ -81,7 +81,7 @@ func addGctsExecuteABAPUnitTestsFlags(cmd *cobra.Command, stepConfig *gctsExecut
 	cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "User to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "Password to authenticate to the ABAP system")
 	cmd.Flags().StringVar(&stepConfig.Repository, "repository", os.Getenv("PIPER_repository"), "Specifies the name (ID) of the local repsitory on the ABAP system")
-	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'. Supported protocols are `http` and `https`.")
+	cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.")
 	cmd.Flags().StringVar(&stepConfig.Client, "client", os.Getenv("PIPER_client"), "Specifies the client of the ABAP system to be adressed")

 	cmd.MarkFlagRequired("username")
--- a/documentation/docs/steps/gctsCloneRepository.md
+++ b/documentation/docs/steps/gctsCloneRepository.md
@ -5,7 +5,7 @@
 ## Prerequisites

 With this step you can clone a remote Git repository to a local repository on an ABAP server. To be able to execute this step, the corresponding local repository has to exist on the local ABAP system.
-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.
+Learn more about the SAP Git-enabled Change & 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}

@ -20,10 +20,10 @@ Example configuration for the use in a `Jenkinsfile`.
 ```groovy
 gctsCloneRepository(
  script: this,
-  host: "https://abap.server.com:port",
-  client: "000",
+  host: 'https://abap.server.com:port',
+  client: '000',
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
-  repository: "myrepo"
+  repository: 'myrepo'
 )
 ```

@ -33,9 +33,8 @@ Example for the use in a YAML configuration file (such as `.pipeline/config.yaml
 steps:
  <...>
  gctsCloneRepository:
-    host: "https://abap.server.com:port"
-    client: "000"
-    username: "ABAPUsername"
-    password: "ABAPPassword"
-    repository: "myrepo"
+    host: 'https://abap.server.com:port'
+    client: '000'
+    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
+    repository: 'myrepo'
 ```
--- a/documentation/docs/steps/gctsCreateRepository.md
+++ b/documentation/docs/steps/gctsCreateRepository.md
@ -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 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.
+Learn more about the SAP Git-enabled Change & 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}

@ -20,13 +20,13 @@ Example configuration for the use in a `Jenkinsfile`.
 ```groovy
 gctsCreateRepository(
  script: this,
-  host: "https://abap.server.com:port",
-  client: "000",
+  host: 'https://abap.server.com:port',
+  client: '000',
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
-  repository: "myrepo",
-  remoteRepositoryURL: "https://github.com/user/myrepo",
-  role: "SOURCE",
-  vSID: "ABC"
+  repository: 'myrepo',
+  remoteRepositoryURL: 'https://github.com/user/myrepo',
+  role: 'SOURCE',
+  vSID: 'ABC'
  )
 ```

@ -36,12 +36,11 @@ Example for the use in a YAML configuration file (such as `.pipeline/config.yaml
 steps:
  <...>
  gctsCreateRepository:
-    host: "https://abap.server.com:port"
-    client: "000"
-    username: "ABAPUsername"
-    password: "ABAPPassword"
-    repository: "myrepo"
-    remoteRepositoryURL: "https://github.com/user/myrepo",
-    role: "SOURCE",
-    vSID: "ABC"
+    host: 'https://abap.server.com:port'
+    client: '000'
+    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
+    repository: 'myrepo'
+    remoteRepositoryURL: 'https://github.com/user/myrepo'
+    role: 'SOURCE'
+    vSID: 'ABC'
 ```
--- a/documentation/docs/steps/gctsDeploy.md
+++ b/documentation/docs/steps/gctsDeploy.md
@ -5,7 +5,7 @@
 ## Prerequisites

 With this step you can deploy a commit from a remote Git repository to a local repository on an ABAP server. If no `commit` parameter is specified, this step will pull the latest commit available on the remote repository.
-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.
+Learn more about the SAP Git-enabled Change & 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}

@ -20,10 +20,10 @@ Example configuration for the use in a `Jenkinsfile`.
 ```groovy
 gctsDeploy(
  script: this,
-  host: "https://abap.server.com:port",
-  client: "000",
+  host: 'https://abap.server.com:port',
+  client: '000',
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
-  repository: "myrepo"
+  repository: 'myrepo'
 )
 ```

@ -33,9 +33,8 @@ Example for the use in a YAML configuration file (such as `.pipeline/config.yaml
 steps:
  <...>
  gctsDeploy:
-    host: "https://abap.server.com:port"
-    client: "000"
-    username: "ABAPUsername"
-    password: "ABAPPassword"
-    repository: "myrepo"
+    host: 'https://abap.server.com:port'
+    client: '000'
+    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
+    repository: 'myrepo'
 ```
--- a/documentation/docs/steps/gctsExecuteABAPUnitTests.md
+++ b/documentation/docs/steps/gctsExecuteABAPUnitTests.md
@ -6,7 +6,7 @@

 * You have gCTS installed and configured on your ABAP systems.

-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.
+Learn more about the SAP Git-enabled Change & 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}

@ -21,10 +21,10 @@ Example configuration for the use in a Jenkinsfile.
 ```groovy
 gctsExecuteABAPUnitTests(
  script: this,
-  host: "https://abap.server.com:port",
-  client: "000",
+  host: 'https://abap.server.com:port',
+  client: '000',
  abapCredentialsId: 'ABAPUserPasswordCredentialsId',
-  repository: "myrepo"
+  repository: 'myrepo'
  )
 ```

@ -34,8 +34,8 @@ Example configuration for the use in a yaml config file (such as `.pipeline/conf
 steps:
  <...>
  gctsExecuteABAPUnitTests:
-    host: "https://abap.server.com:port"
-    client: "000"
+    host: 'https://abap.server.com:port'
+    client: '000'
    abapCredentialsId: 'ABAPUserPasswordCredentialsId'
-    repository: "myrepo"
+    repository: 'myrepo'
 ```
--- a/resources/metadata/gctsCloneRepository.yaml
+++ b/resources/metadata/gctsCloneRepository.yaml
@ -39,7 +39,7 @@ spec:
        mandatory: true
      - name: host
        type: string
-        description: Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'
+        description: Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
        scope:
        - PARAMETERS
        - STAGES
--- a/resources/metadata/gctsCreateRepository.yaml
+++ b/resources/metadata/gctsCreateRepository.yaml
@ -39,7 +39,7 @@ spec:
        mandatory: true
      - name: host
        type: string
-        description: Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'
+        description: Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
        scope:
        - PARAMETERS
        - STAGES
--- a/resources/metadata/gctsDeployCommit.yaml
+++ b/resources/metadata/gctsDeployCommit.yaml
@ -39,7 +39,7 @@ spec:
        mandatory: true
      - name: host
        type: string
-        description: Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'
+        description: Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
        scope:
        - PARAMETERS
        - STAGES
--- a/resources/metadata/gctsExecuteABAPUnitTests.yaml
+++ b/resources/metadata/gctsExecuteABAPUnitTests.yaml
@ -39,7 +39,7 @@ spec:
        mandatory: true
      - name: host
        type: string
-        description: Specifies the protocol and host adress, including the port. Please provide in the format '<protocol>://<host>:<port>'. Supported protocols are `http` and `https`.
+        description: Specifies the protocol and host adress, including the port. Please provide in the format `<protocol>://<host>:<port>`. Supported protocols are `http` and `https`.
        scope:
        - PARAMETERS
        - STAGES