Skip to content

test(examples): keep README snippets and examples correct via CI - #2676

Open
davidberenstein1957 wants to merge 3 commits into
mainfrom
test/examples-readme-contract
Open

test(examples): keep README snippets and examples correct via CI#2676
davidberenstein1957 wants to merge 3 commits into
mainfrom
test/examples-readme-contract

Conversation

@davidberenstein1957

Copy link
Copy Markdown
Member

Summary

  • Add offline examples/checks_static and examples/scan_stub pytest modules mirroring public API usage
  • Add examples/lint_readme_snippets.py AST lint forbidding positional CheckResult.success/failure(str)
  • Fix libs/giskard-checks/README.md fences to use message=
  • Add make test-examples and a test-examples CI job
  • Document the contract in CONTRIBUTING

Closes #2667

Test plan

  • make test-examples

@davidberenstein1957
davidberenstein1957 requested a review from a team as a code owner July 29, 2026 17:39
Move scenarios onto the fake suite instance so RUF012 passes in CI.
Reformat README snippets so make check passes with ruff format on CI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

test: keep in-repo examples and README snippets correct via CI

1 participant