fix(tests): cover the example/ demo the docs send users to - #1220
Merged
Conversation
docs/examples.md opens by pointing at example/, and example/README.md tells readers to run `./bashunit example` from the project root. Nothing ran it: `make test` collects from tests/ only, no workflow mentions the folder, and no test referenced it -- so the first thing a new user runs could break while CI stayed green. Assert the outcome rather than a test count, so adding an example does not fail the guard, and cover both modes plus the folder actually holding tests -- a guard over an empty folder would pass forever. Also drop EXAMPLE_TEST_SCRIPTS: it pointed at example/logic_test.sh, deleted in a255fa7, and the recipes that used it went away in a570e9a. Closes #1219
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
🤔 Background
Related #1219
docs/examples.mdopens by pointing readers atexample/, andexample/README.mdtells them to run./bashunit examplefrom the project root — a new user's first contact with the framework. Nothing ran it:make testcollects fromtests/only, no workflow mentions the folder, and no test referenced it, so the demo could rot while CI stayed green.💡 Changes
make testEXAMPLE_TEST_SCRIPTSvariable — it pointed atexample/logic_test.sh, deleted in a255fa7, and its recipes went away in a570e9a