Skip to content

feat: add docs for metadata in config file#598

Merged
nehagup merged 3 commits intomainfrom
doc/config-metadat
Jul 1, 2025
Merged

feat: add docs for metadata in config file#598
nehagup merged 3 commits intomainfrom
doc/config-metadat

Conversation

@officialasishkumar
Copy link
Member

What has changed?

Please include a summary of the change.

This PR Resolves keploy/keploy#2817

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 AI review requested due to automatic review settings June 30, 2025 09:47
Copy link

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 documentation for the new --metadata flag for the keploy record command, providing users with examples and usage details for adding key-value metadata entries in the config file.

  • Updated the CLI commands table to include the --metadata flag.
  • Added detailed usage examples and description for the --metadata flag.
Comments suppressed due to low confidence (1)

versioned_docs/version-3.0.0/running-keploy/cli-commands.md:75

  • [nitpick] Consider clarifying the expected format for metadata key-value pairs, including details on separators, escaping rules (if any), and allowed characters, to help users avoid input errors.
- `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name.

Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@github-actions github-actions bot force-pushed the doc/config-metadat branch from 3e4b5be to 994c2f1 Compare June 30, 2025 09:47
@gouravkrosx gouravkrosx self-requested a review June 30, 2025 12:07
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@github-actions github-actions bot force-pushed the doc/config-metadat branch from 4d69170 to 3ba581e Compare July 1, 2025 10:01
Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
@nehagup nehagup merged commit 40966d8 into main Jul 1, 2025
5 of 7 checks passed
@nehagup nehagup deleted the doc/config-metadat branch July 1, 2025 11:10
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.

[feature]: add a new field called metadata in config file

3 participants