V0.1.1/fixes#43
Merged
Merged
Conversation
Added doctest directives to all module test files. Heavy examples are excluded on purpose: - LivebookTest — only run_with_config/2 (not full run/1 / run_and_report/1) - Runner — excludes run/2 (subprocess) - Exporter — excludes temp-file functions (side effects) Fixed two doctest issues: - Report.format/1 — added missing empty: false to the struct - DependencyPatcher.patch/3 — switched to ~S|...| sigils for nested quotes 23 doctests now run in CI. T2 — Real local-mode E2E test, closed #34 Replaced the weak test (local_deps: [livebook_test: "."] against a jason notebook) with one that: - Uses local_deps: [jason: "."] matching livebooks/local_dep.livemd - Reads the patched script via MockRunner and asserts {:jason, path: "<abs path>"} - Asserts ~> 1.4 is gone C1 — :runner / :preflight threaded through run/1, closed #33 - Added to @type run_option and docs - run/1 splits opts and passes :runner / :preflight to run_with_config/2 - Documented run_with_config/2 options - Added tests proving both run/1 and run_an injected runners DC1 — Removed dead Config.from_cli/1, closed #35 Deleted from_cli/1, its four private helpers, and the nine tests that only exercised dead code.
docs/guides/executable_documentation.md now uses a ````markdown ```` outer fence so inner ```elixir ```` blocks render correctly. Also softened the ExDoc claim (D2 bonus): renamed section to "Including Notebooks in ExDoc" and clarified it's independent of livebook_test. C2 / D3 / D4 — Documentation accuracy - C2 / D3 — Already addressed in the prior fix (run_and_report/1 documents exit code 2; run_with_config/2 documents :runner and :preflight). Closed #37 and closed #38 - D4 — Install snippets updated to ~> 0.1 in README.md and lib/livebook_test.ex. L1 — Emoji removed - report.ex success message: "All notebooks passed!" (no ✅) - README.md example output updated to match C3 — Harness errors distinguished Added harness_error: boolean() to LivebookTest.Runner: - false for normal notebook exits (including timeouts) - true for internal runner failures (error_result/2) Report output now shows harness error: instead of exit: 1 for harness failures. Tests cover formatting and confirm missing-script failures are not marked as harness errors.
executable_documentation.md already says notebooks can be included in ExDoc independently of livebook_test. No further change.
T4 — CI local-mode step now tests patching
- Added local_deps: [jason: "."] to config/config.exs so local mode has a real mapping
- CI step renamed and narrowed to: mix livebook.test --mode local --path livebooks/local_dep.livemd This runs the notebook that declares {:jason, "~> 1.4"} and verifies patching end-to-end in CI.
DC2 / DC3 — Dead scaffolding removed
- Removed empty aliases/0 and its reference from mix.exs
- Replaced extra_applications: [:logger] with application do: [] (Logger was unused)
L2 / L3 — Tone and punctuation
- Replaced marketing phrases: "killer feature" → "A core feature", "most powerful feature" → "A core feature of", "powerful way" → "practical way"
- Replaced em-dashes with hyphens or rephrasing in README.md, guides, report.ex, mix task moduledoc, dependency_patcher.ex, discovery.ex, and preflight.ex
…rlier v0.1.1 work; I finished the last bits and confirmed tests pass (161 total, 0 failures).
Fixed items
ID Fix
D2
docs/guides/executable_documentation.md now says Livebook .livemd files can be included in ExDoc independently of livebook_test.
D4
Install snippets use ~> 0.1 in README.md and lib/livebook_test.ex.
C3
Runner results include harness_error: true; reports show harness error: instead of exit: 1 for runner failures.
T4
config/config.exs sets local_deps: [jason: "."]; CI runs mix livebook.test --mode local --path livebooks/local_dep.livemd.
L1
Removed ✅ from report.ex and README example output.
DC2
Removed empty aliases/0 from mix.exs.
DC3
Removed unused :logger from extra_applications (application/0 is now []).
L2
Replaced marketing phrasing (“killer feature”, etc.) with neutral wording in README and guides.
L3
Replaced em-dashes with plain hyphens in user-facing lib strings and docs; last holdout was dependency_patcher.ex moduledoc examples.
Also updated
CHANGELOG.md — documents harness errors, CI local-mode coverage, and doc/output cleanup.
test/report_test.exs — asserts harness error output includes the inspected reason ({:execution_failed, "boom"}).
Say if you want a commit or a comment on the GitHub issue to close it.
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.
No description provided.