docs: clarify how to rename a Test-Set#835
Conversation
The Rename Test-Sets section on running-keploy/rename-testcases.md was a single sentence telling users they could rename test-set-0, without explaining why Keploy accepts the rename or how to reference the renamed set at replay time. Expand the section to cover: - How Keploy discovers Test-Sets (by listing subdirectories of keploy/), so any folder name works. - The reserved folder names to avoid (reports, testReports, schema). - How to reference the renamed Test-Set via --test-sets (-t) at replay time. - That report files generated before the rename keep the old Test-Set name in their filenames under keploy/reports/test-run-*/. Refs: keploy/keploy#4069 Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR expands the Rename Test-Sets guidance in the v4.0.0 docs to explain how Keploy discovers Test-Set directories, which names are reserved, how to target renamed Test-Sets at replay time, and how renames affect report filenames.
Changes:
- Replaced the single-sentence “rename test-set-0” instruction with a more complete explanation of folder-based discovery.
- Documented reserved directory names to avoid and how to run
keploy testagainst a renamed Test-Set via-t/--test-sets. - Added a note about how pre-existing report filenames behave across a rename.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| keploy test -c "<your app cmd>" -t "checkout-flow" | ||
| ``` | ||
|
|
||
| Report files generated before the rename keep the old Test-Set name in their filenames under `keploy/reports/test-run-*/`. Runs after the rename use the new name. |
There was a problem hiding this comment.
The path/pattern here is inconsistent with other v4.0.0 docs: keploy/reports/test-run-*/ (with a trailing /) reads like a directory glob, but cli-commands.md documents report files like keploy/reports/test-run-1.yaml and risk-profile-analysis.md references test-run-*-report.yaml. To avoid misleading users, please update this sentence to use the actual report filename pattern (and remove the trailing slash if these are files).
| Report files generated before the rename keep the old Test-Set name in their filenames under `keploy/reports/test-run-*/`. Runs after the rename use the new name. | |
| Report files generated before the rename keep the old Test-Set name in their filenames under `keploy/reports/test-run-*.yaml`. Runs after the rename use the new name. |
What has changed?
The Rename Test-Sets section on
versioned_docs/version-4.0.0/running-keploy/rename-testcases.mdwas a single sentence that told users they could renametest-set-0, but didn't explain:test-set-prefix filter).reports,testReports,schema).-t/--test-sets).This PR expands the section to cover all four points, verified against
pkg/platform/yaml/yaml.go:ReadSessionIndicesinkeploy/keploy.This PR Resolves keploy/keploy#4069
Type of change
How Has This Been Tested?
Prose-only change. Verified locally:
vale versioned_docs/version-4.0.0/running-keploy/rename-testcases.md— 0 errors on changed lines (filter_mode: diff_contextin CI skips the two pre-existing frontmatter/example errors on unchanged lines).npx prettier@2.8.8 --check versioned_docs/version-4.0.0/running-keploy/rename-testcases.md— clean.Checklist: