Skip to content

feat(integration): README runnable snippets - #352

Merged
0xsamuel1 merged 2 commits into
soroban-testkit:mainfrom
Dinma179:feat/214-readme-runnable-snippets
Oct 20, 2026
Merged

0xsamuel1 merged 2 commits into
soroban-testkit:mainfrom
Dinma179:feat/214-readme-runnable-snippets

Conversation

@Dinma179

@Dinma179 Dinma179 commented Oct 19, 2026 •

Copy link
Copy Markdown

Makes every user-facing README example verified as executable.

Tasks accomplished:

  • Tag the escrow Rust example as rust so it runs as a doctest via lib.rs include
  • Add readme_snippets integration tests for sh commands (help, dry-run, error shapes, fence allowlist)
  • Add explicit CI steps for doctests and snippet tests
  • Repair blocking coverage.rs merge breakage and stale snapshots/docs so verification passes network-free
  • Run cargo test --workspace and cargo doc --workspace

Bounded scope: README.md verification only; sh blocks needing network/browser/wasm are checked for real subcommands/flags, not executed; install path remains covered by smoke-test-install. Preserves network-free behavior and CliError conventions (exit 1 + error: prefix).

Local verification: cargo test --workspace passes; RUSTDOCFLAGS=-D warnings cargo doc --workspace --no-deps passes.

closes #214
closes #206
closes #208

Tag the escrow example as rust so it runs as a doctest via lib.rs,
add readme_snippets integration coverage for sh commands, and add
explicit CI steps for doctests and snippet tests.

Also repairs the broken coverage.rs merge that blocked compilation
and updates stale help snapshots, coverage error docs, and module
doctests so cargo test and cargo doc pass network-free.
@drips-wave

drips-wave Bot commented Oct 19, 2026

Copy link
Copy Markdown

@Dinma179 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@0xsamuel1
0xsamuel1 merged commit 5e45810 into soroban-testkit:main Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(integration): README runnable snippets fix(integration): workspace validation docs feat(integration): contributor issue checklist

2 participants