-
Notifications
You must be signed in to change notification settings - Fork 229
docs: add docs for test-set-config #655
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
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.
Pull Request Overview
This PR adds comprehensive documentation for the test-set configuration file feature in Keploy version 3.0.0. The documentation explains how to use config.yaml
files alongside test data to customize runtime parameters on a per-test-set basis.
- Adds complete documentation for test-set configuration functionality
- Provides practical examples and troubleshooting guidance
- Includes best practices for managing test-set specific configurations
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
my-test-set/ | ||
mock.yaml # Recorded mocks for this test-set | ||
config.yaml # Test-set specific configuration (optional) | ||
... # Any other assets |
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.
Inconsistent indentation in the directory structure example. Use consistent spacing (either tabs or spaces) for proper formatting in documentation.
my-test-set/ | |
mock.yaml # Recorded mocks for this test-set | |
config.yaml # Test-set specific configuration (optional) | |
... # Any other assets | |
my-test-set/ | |
mock.yaml # Recorded mocks for this test-set | |
config.yaml # Test-set specific configuration (optional) | |
... # Any other assets |
Copilot uses AI. Check for mistakes.
|
||
You can extend `config.yaml` later if needed. Common fields (all optional unless noted): | ||
|
||
common example - |
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.
The text 'common example -' should be capitalized and have proper punctuation: 'Common example:'
common example - | |
Common example: |
Copilot uses AI. Check for mistakes.
Signed-off-by: Sarthak160 <[email protected]>
723dac1
to
ee520f7
Compare
What has changed?
Please include a summary of the change.
This PR Resolves #(issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
Checklist: