docs: note that VCR cassettes are intentionally not committed

brendancsmith · brendancsmith · commit 53af8734a153 · 2026-07-06T02:20:15.000-05:00
Explain in the cassettes .gitignore that the functional suite runs against
the live Diffbot API by design, so cassettes must not be committed to force
deterministic CI. Prevents a future contributor from "fixing" bulk-job
flakiness by pinning recordings instead of the poll timeout.
diff --git a/tests/functional/clients/cassettes/.gitignore b/tests/functional/clients/cassettes/.gitignore
@@ -1 +1,7 @@
+# VCR cassettes are intentionally not committed. The functional suite runs
+# against the live Diffbot API in CI (record_mode="new_episodes"), so tests
+# exercise the real service rather than replaying recordings. Do not commit
+# cassettes to make CI deterministic — live coverage is the intended behavior.
+# Flaky bulk-job timeouts are mitigated by the poll timeout in
+# test_enhance_client.py, not by pinning recordings.
 *

Original file line number	Diff line number	Diff line change
`@@ -1 +1,7 @@`
	`1`	`+# VCR cassettes are intentionally not committed. The functional suite runs`
	`2`	`+# against the live Diffbot API in CI (record_mode="new_episodes"), so tests`
	`3`	`+# exercise the real service rather than replaying recordings. Do not commit`
	`4`	`+# cassettes to make CI deterministic — live coverage is the intended behavior.`
	`5`	`+# Flaky bulk-job timeouts are mitigated by the poll timeout in`
	`6`	`+# test_enhance_client.py, not by pinning recordings.`
`1`	`7`	`*`