Skip to content

Conversation

Sarthak160
Copy link
Member

What has changed?

Please include a summary of the change.

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

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:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@Copilot Copilot AI review requested due to automatic review settings September 6, 2025 08:51
Copy link

@Copilot Copilot AI left a 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.

Comment on lines +14 to +17
my-test-set/
mock.yaml # Recorded mocks for this test-set
config.yaml # Test-set specific configuration (optional)
... # Any other assets
Copy link
Preview

Copilot AI Sep 6, 2025

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.

Suggested change
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 -
Copy link
Preview

Copilot AI Sep 6, 2025

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:'

Suggested change
common example -
Common example:

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant