Add CONTRIBUTING guide and improve test diagnostics#6
Merged
Conversation
- Add CONTRIBUTING.md documenting prerequisites, installing Bats + helper libraries, running the suite, and how CI (incl. the daily scheduled run) exercises stable and HEAD DDEV. - test.bats: when CI is re-run with debug logging (RUNNER_DEBUG=1), set BATS_VERBOSE_RUN so `run` prints every command's $output on failure. This surfaces the post-start hook log captured by `run ddev restart`, which is otherwise swallowed when restart succeeds. - test.bats: omit the db and ddev-ssh-agent containers, which the suite doesn't use, for faster project start. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
andrewbelcher
force-pushed
the
improve-test-suite
branch
from
9d08cd7 to
395ff83
Compare
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.
What
CONTRIBUTING.md— prerequisites, installing Bats + thebats-assert/bats-file/bats-supporthelpers (macOS and Linux), running the suite locally, and how CI exercises bothstableandHEADDDEV (including the daily scheduled run that also runsinstall from release).tests/test.bats:RUNNER_DEBUG=1), setBATS_VERBOSE_RUNsorunprints every command's$outputon failure. This surfaces the post-start hook log captured byrun ddev restart, which is otherwise swallowed when restart succeeds — exactly what was needed to diagnose a recent HEAD-only failure.dbandddev-ssh-agentcontainers (unused by the suite) for a faster project start.Why
Post-start hook failures are non-fatal in DDEV, so
ddev restartexits 0 even when a hook fails. Without verbose output that failure is invisible. GatingBATS_VERBOSE_RUNonRUNNER_DEBUGkeeps normal runs quiet but makes a debug re-run show the hook log, with no change to how the ddev test action invokes bats.🤖 Generated with Claude Code