docs: review failure diagnostics - #288
Draft
Tomoscorbin wants to merge 2 commits into
Draft
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
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.
Summary
UnmanagedAspectDrift, does not show the exact differencesWhy
Recent READ and validation failures did not provide enough information to diagnose the problem. The review traces failure values through the report, CLI, exceptions, and
to_dict()output and records the concrete gaps before changing the public reporting contract.The highest-priority findings are that rejected drift is rendered as “no changes,” READ failures do not retain the failing catalog-read step, and the CLI can present the same expected READ failure three times.
Impact
This is documentation-only. It proposes a cause-first diagnostics contract and a staged implementation plan; runtime behaviour and public APIs are unchanged.
Validation
uv run pytest -q --no-cov tests/application/test_failures.py tests/application/test_rendering.py tests/application/test_report.py tests/application/test_validation.py tests/cli/test_app_plan.py tests/adapters/databricks/test_read.py tests/adapters/databricks/test_execution.pygit diff --cached --check