diff --git a/cmd/gctsCloneRepository_generated.go b/cmd/gctsCloneRepository_generated.go index 3db7d3cc1..af81759a3 100644 --- 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 '://:'") + cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `://:`. 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") diff --git a/cmd/gctsCreateRepository_generated.go b/cmd/gctsCreateRepository_generated.go index 01f925329..46f6f9d73 100644 --- 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 '://:'") + cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `://:`. 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") diff --git a/cmd/gctsDeploy_generated.go b/cmd/gctsDeploy_generated.go index 6f5fc106c..4f8359d90 100644 --- 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 '://:'") + cmd.Flags().StringVar(&stepConfig.Host, "host", os.Getenv("PIPER_host"), "Specifies the protocol and host adress, including the port. Please provide in the format `://:`. 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") diff --git a/cmd/gctsExecuteABAPUnitTests_generated.go b/cmd/gctsExecuteABAPUnitTests_generated.go index 4649597e3..4488c1a1e 100644 --- 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 '://:'. 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 `://:`. 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") diff --git a/documentation/docs/steps/gctsCloneRepository.md b/documentation/docs/steps/gctsCloneRepository.md index 985b05ea2..a49123be3 100644 --- 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' ``` diff --git a/documentation/docs/steps/gctsCreateRepository.md b/documentation/docs/steps/gctsCreateRepository.md index faa4f4396..f2bfeda26 100644 --- 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' ``` diff --git a/documentation/docs/steps/gctsDeploy.md b/documentation/docs/steps/gctsDeploy.md index 5144c50e9..691128352 100644 --- 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' ``` diff --git a/documentation/docs/steps/gctsExecuteABAPUnitTests.md b/documentation/docs/steps/gctsExecuteABAPUnitTests.md index 59d6b9fc2..451159997 100644 --- 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' ``` diff --git a/resources/metadata/gctsCloneRepository.yaml b/resources/metadata/gctsCloneRepository.yaml index a5d6e8080..71330b817 100644 --- 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 '://:' + description: Specifies the protocol and host adress, including the port. Please provide in the format `://:`. Supported protocols are `http` and `https`. scope: - PARAMETERS - STAGES diff --git a/resources/metadata/gctsCreateRepository.yaml b/resources/metadata/gctsCreateRepository.yaml index 11cecf274..aca1404a9 100644 --- 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 '://:' + description: Specifies the protocol and host adress, including the port. Please provide in the format `://:`. Supported protocols are `http` and `https`. scope: - PARAMETERS - STAGES diff --git a/resources/metadata/gctsDeployCommit.yaml b/resources/metadata/gctsDeployCommit.yaml index 82827117e..acf87dac8 100644 --- 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 '://:' + description: Specifies the protocol and host adress, including the port. Please provide in the format `://:`. Supported protocols are `http` and `https`. scope: - PARAMETERS - STAGES diff --git a/resources/metadata/gctsExecuteABAPUnitTests.yaml b/resources/metadata/gctsExecuteABAPUnitTests.yaml index 7cd4c2081..49c353e3b 100644 --- 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 '://:'. Supported protocols are `http` and `https`. + description: Specifies the protocol and host adress, including the port. Please provide in the format `://:`. Supported protocols are `http` and `https`. scope: - PARAMETERS - STAGES