fix: improve error message when baseline is missing and both flags are false #1099
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e false - Improve error message in checkBaselineImageExists to provide guidance when alwaysSaveActualImage is false and baseline doesn't exist - Add helpful message suggesting users set alwaysSaveActualImage to true if they need the actual image to create a baseline - Add test to verify the improved error message - Respect user's explicit configuration choice (both flags set to false) Fixes #1098
🦋 Changeset detectedLatest commit: 8414ffc The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR improves the error message when a baseline image is missing and both
autoSaveBaseline = falseandalwaysSaveActualImage = false.Changes
checkBaselineImageExiststo suggest users setalwaysSaveActualImagetotrueif they need the actual image to create a baseline manuallyAnalysis
The current behavior is correct. When both
autoSaveBaseline = falseandalwaysSaveActualImage = false, we should respect the user's explicit configuration choice and not save the actual image. This is by design - the user has told the system not to save images in this scenario.However, the error message could be more helpful by guiding users on how to adjust their configuration if they need the actual image to create a baseline manually.
Testing
Related Issue
Fixes #1098