-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
tmt, tmt-run, tmt-try: add pages #14921
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
|
||
- List available tests, plans, or stories: | ||
|
||
`tmt <test|plan|story> ls {{pattern}}` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`tmt <test|plan|story> ls {{pattern}}` | |
`tmt {{test|plan|story}} ls {{pattern}}` |
|
||
- Run a test in the current working directory: | ||
|
||
`{{cd path/to/test &&}} tmt try` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`{{cd path/to/test &&}} tmt try` | |
`cd {{path/to/test}} && tmt try` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi. Thank you so much for your contribution to our project. Welcome to tldr-pages! I left a few suggestions for you.
# tmt run | ||
|
||
> Execute tmt test steps. By default, all steps are run. | ||
> See also: `tmt`, `tmt-try`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> See also: `tmt`, `tmt-try`. |
We do not use this syntax to reference other subcommands.
# tmt try | ||
|
||
> Quickly experiment with tests and environments. | ||
> See also: `tmt`, `tmt-run`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> See also: `tmt`, `tmt-run`. |
the same as above
# tmt | ||
|
||
> Test Management Tool for creating, running and debugging tests. | ||
> See also: `tmt-run`, `tmt-try`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> See also: `tmt-run`, `tmt-try`. | |
> Some subcommands such as `run`, `try`, etc. have their own usage documentation. |
For subcommand mention we use this syntax:
https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/subcommand-mention.md
> See also: `tmt-run`, `tmt-try`. | ||
> More information: <https://tmt.readthedocs.io>. | ||
- Look around to see what's available: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Look around to see what's available: | |
- List available tests, plans, and stories: |
|
||
`tmt init` | ||
|
||
- Create a new test with template and link: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Create a new test with template and link: | |
- Create a new test with a template and link: |
@@ -0,0 +1,37 @@ | |||
# tmt | |||
|
|||
> Test Management Tool for creating, running and debugging tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> Test Management Tool for creating, running and debugging tests. | |
> Test Management Tool for creating, running, and debugging tests. |
> See also: `tmt`, `tmt-run`. | ||
> More information: <https://tmt.readthedocs.io/en/stable/stories/cli.html#try>. | ||
- Quickly experiment with the default provision method (no tests in cwd): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Quickly experiment with the default provision method (no tests in cwd): | |
- Quickly experiment with the default provision method (no tests in the CWD): |
|
||
`tmt run --all execute --how {{tmt}} --interactive` | ||
|
||
- Use dry mode to see what actions would happen and use highest verbosity: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Use dry mode to see what actions would happen and use highest verbosity: | |
- Use dry mode to see what actions would happen and use the highest verbosity: |
|
||
`tmt run discover -v` | ||
|
||
- Run all steps, adjust the provision step options: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Run all steps, adjust the provision step options: | |
- Run all steps and adjust the provision step options: |
common
,linux
,osx
,windows
,sunos
,android
, etc.