jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-03-27 21:49:15 +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
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/npmExecuteTests_generated.go
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.UsernameEnvVar, "usernameEnvVar", `wdi5_username`, "Env var for username.")
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.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")

6
documentation/docs/steps/npmExecuteTests.md
View File

@ -1,7 +1,7 @@
# ${docGenStepName} (Beta)
# ${docGenStepName}
[!WARNING]
Please note, that the npmExecuteTests step is in beta state, and there could be breaking changes before we remove the beta notice.
> [!WARNING]
> Please note, that the npmExecuteTests step is in beta state, and there could be breaking changes before we remove the beta notice.
## ${docGenDescription}

2
resources/metadata/npmExecuteTests.yaml
View File

@ -96,7 +96,7 @@ spec:
type: string
description: |
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.
scope:
- PARAMETERS