Document custom templates support in k6 new
#1889
Open
+10
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrewslotin
added
the
Area: OSS Content
andrewslotin
requested review from
oleiade and
olegbespalov
and removed request for
a team
7 tasks
olegbespalov
approved these changes
Mar 12, 2025
|
|
||
| ```bash | ||
| k6 new --template protocol | ||
| ``` | ||
|
|
||
| ### --project-id | ||
|
|
||
| The `--project-id` allows you to specify a Grafana Cloud k6 project ID. The generated script is then configured to run in that project. | ||
| The `--project-id` allows you to specify a Grafana Cloud k6 project ID. The generated script is then configured to run in that project. To include the project ID in your custom template, use `{{ .ProjectID }}` as a placeholder, for example: |
There was a problem hiding this comment.
Suggested change
| The `--project-id` allows you to specify a Grafana Cloud k6 project ID. The generated script is then configured to run in that project. To include the project ID in your custom template, use `{{ .ProjectID }}` as a placeholder, for example: | |
| The `--project-id` flag allows you to specify a Grafana Cloud k6 project ID. The generated script is then configured to run in that project. To include the project ID in your custom template, use `{{ .ProjectID }}` as a placeholder, for example: |
heitortsergent
approved these changes
Mar 12, 2025
There was a problem hiding this comment.
@andrewslotin thanks for opening this PR! I think the changes look good. This could be a separate PR, but what do you think about adding some examples for creating a custom template?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Document custom script templates support coming in k6 v1.0.0-rc1.
Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)
grafana/k6#4618