Problem
docs/examples.md opens by sending readers to the example/ folder, and example/README.md tells them to run ./bashunit example from the project root. That is a new user's first contact with the framework.
Nothing runs it:
make test collects from $(TEST_SCRIPTS_DIR) = tests only- no workflow in
.github/workflows/ references example/
- no file under
tests/ references it either
So the demo can rot — a renamed assertion, a changed flag, a moved source file — while CI stays green, and the first thing a new user runs is the thing that breaks.
It passes today (4 tests, exit 0, sequential and --parallel), which is exactly why it should be pinned now rather than after it breaks.
Also: a dead Makefile variable
EXAMPLE_TEST_SCRIPTS=./example/logic_test.sh
example/logic_test.sh was deleted in a255fa7. The variable is defined on line 65 and used nowhere — the recipes that consumed it went away in a570e9a. The real files are custom_functions_test.sh and script_logic_test.sh.
Suggested fix
Add an acceptance test that runs the folder the way the README documents and asserts it succeeds, so the guard runs in every CI mode rather than only under make test. Drop the dead variable.
Verified correct in the same guide
docs/examples.md is otherwise clean: all ten external links resolve (200), the example/ folder exists with the tests it advertises, and the README's exact command works in both sequential and parallel modes.
Problem
docs/examples.mdopens by sending readers to theexample/folder, andexample/README.mdtells them to run./bashunit examplefrom the project root. That is a new user's first contact with the framework.Nothing runs it:
make testcollects from$(TEST_SCRIPTS_DIR)=testsonly.github/workflows/referencesexample/tests/references it eitherSo the demo can rot — a renamed assertion, a changed flag, a moved source file — while CI stays green, and the first thing a new user runs is the thing that breaks.
It passes today (4 tests, exit 0, sequential and
--parallel), which is exactly why it should be pinned now rather than after it breaks.Also: a dead Makefile variable
EXAMPLE_TEST_SCRIPTS=./example/logic_test.shexample/logic_test.shwas deleted in a255fa7. The variable is defined on line 65 and used nowhere — the recipes that consumed it went away in a570e9a. The real files arecustom_functions_test.shandscript_logic_test.sh.Suggested fix
Add an acceptance test that runs the folder the way the README documents and asserts it succeeds, so the guard runs in every CI mode rather than only under
make test. Drop the dead variable.Verified correct in the same guide
docs/examples.mdis otherwise clean: all ten external links resolve (200), theexample/folder exists with the tests it advertises, and the README's exact command works in both sequential and parallel modes.