Instructional sharness snapshot error message #3309
Merged
Conversation
This file contains 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
amrro
approved these changes
Jan 28, 2022
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
When sharness-full fails, it's usually just because a code change was made that requires the snapshots to be updated, but currently that's only really passed on person to person as institutional knowledge. This PR adds some comments in the test file that are output in the console log so that any future maintainer or contributor can be pointed in the direction of the update_snapshots.sh script.
Test Plan
I had CI run with this on code that needed a snapshot update. Open this run and browser search "not ok" to see the helpful tip displayed.
https://app.circleci.com/pipelines/github/sourcecred/sourcecred/7447/workflows/e66948ff-2814-4c11-a2c2-d77813ccd700/jobs/19653