jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2026-06-19 22:58:55 +02:00
Code Issues Releases Activity

docs: fix npmExuceteTests documentation formatting issues (#5218)

Browse Source
This commit is contained in:
phgermanov
2025-01-03 13:28:34 +02:00
committed by GitHub
parent 531a0b8cfe
commit 04e5df1277
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/npmExecuteTests_generated.go
+1 -1
View File
@@ -207,7 +207,7 @@ func addNpmExecuteTestsFlags(cmd *cobra.Command, stepConfig *npmExecuteTestsOpti
cmd.Flags().StringVar(&stepConfig.BaseURL, "baseUrl", `http://localhost:8080/index.html`, "Base URL of the application to be tested.") cmd.Flags().StringVar(&stepConfig.BaseURL, "baseUrl", `http://localhost:8080/index.html`, "Base URL of the application to be tested.")
cmd.Flags().StringVar(&stepConfig.UsernameEnvVar, "usernameEnvVar", `wdi5_username`, "Env var for username.") cmd.Flags().StringVar(&stepConfig.UsernameEnvVar, "usernameEnvVar", `wdi5_username`, "Env var for username.")
cmd.Flags().StringVar(&stepConfig.PasswordEnvVar, "passwordEnvVar", `wdi5_password`, "Env var for password.") cmd.Flags().StringVar(&stepConfig.PasswordEnvVar, "passwordEnvVar", `wdi5_password`, "Env var for password.")
cmd.Flags().StringVar(&stepConfig.UrlOptionPrefix, "urlOptionPrefix", os.Getenv("PIPER_urlOptionPrefix"), "If you want to specify an extra option that the tested url it appended to.\nFor example if the test URL is `http://localhost and urlOptionPrefix is `--base-url=`,\nwe'll add `--base-url=http://localhost` to your runScript.\n") cmd.Flags().StringVar(&stepConfig.UrlOptionPrefix, "urlOptionPrefix", os.Getenv("PIPER_urlOptionPrefix"), "If you want to specify an extra option that the tested url it appended to.\nFor example if the test URL is `http://localhost` and urlOptionPrefix is `--base-url=`,\nwe'll add `--base-url=http://localhost` to your runScript.\n")
cmd.Flags().StringSliceVar(&stepConfig.Envs, "envs", []string{}, "List of environment variables to be set") cmd.Flags().StringSliceVar(&stepConfig.Envs, "envs", []string{}, "List of environment variables to be set")
cmd.Flags().StringSliceVar(&stepConfig.Paths, "paths", []string{}, "List of paths to be added to $PATH") cmd.Flags().StringSliceVar(&stepConfig.Paths, "paths", []string{}, "List of paths to be added to $PATH")
cmd.Flags().StringVar(&stepConfig.WorkingDirectory, "workingDirectory", `.`, "Directory where your tests are located relative to the root of your project") cmd.Flags().StringVar(&stepConfig.WorkingDirectory, "workingDirectory", `.`, "Directory where your tests are located relative to the root of your project")
documentation/docs/steps/npmExecuteTests.md
+3 -3
View File
@@ -1,7 +1,7 @@
# ${docGenStepName} (Beta) # ${docGenStepName}
[!WARNING] > [!WARNING]
Please note, that the npmExecuteTests step is in beta state, and there could be breaking changes before we remove the beta notice. > Please note, that the npmExecuteTests step is in beta state, and there could be breaking changes before we remove the beta notice.
## ${docGenDescription} ## ${docGenDescription}
resources/metadata/npmExecuteTests.yaml
+1 -1
View File
@@ -96,7 +96,7 @@ spec:
type: string type: string
description: | description: |
If you want to specify an extra option that the tested url it appended to. If you want to specify an extra option that the tested url it appended to.
For example if the test URL is `http://localhost and urlOptionPrefix is `--base-url=`, For example if the test URL is `http://localhost` and urlOptionPrefix is `--base-url=`,
we'll add `--base-url=http://localhost` to your runScript. we'll add `--base-url=http://localhost` to your runScript.
scope: scope:
- PARAMETERS - PARAMETERS