Skip to content

docs(migration): runnable published before-and-after demo for adoption - #90

Merged
agustin18 merged 16 commits into
stablefrom
docs/88-before-after-migration-demo
Nov 21, 2026
Merged

agustin18 merged 16 commits into
stablefrom
docs/88-before-after-migration-demo

Conversation

@agustin18

@agustin18 agustin18 commented Nov 21, 2026 •

Copy link
Copy Markdown
Owner

Goal

Provide a runnable, single-command before-and-after migration demo for the already published fastapi-cache2==0.2.2 and fastapi-cache-stable==0.5.0. This is an adoption/docs PR for the future 0.6.0 promotion, not a new release or a substitute for Redis E2E evidence.

What this PR adds

  • python examples/migration/run_demo.py uses two disposable, isolated virtual environments (CPython 3.11/3.12; Windows/macOS/Linux), refuses co-installation, checks installed distributions and executes identical fastapi_cache imports in each with -I.
  • Verifies anonymous MISS → HIT, weak ETag/304, and the intentionally different behavior for fictional authenticated requests: published upstream reuses demo viewer data; published 0.5.0 bypasses the cache.
  • Reports contain no token values, use no Redis server or production data and remove temporary environments after the run.
  • Dedicated read-only GitHub Actions workflow exercises the published-vs-published demonstration on Py3.11 and 3.12, in addition to negative comparator tests in the normal CI.
  • Entry points added to root README, examples index and migration guide. Towncrier fragment added.

Required review / evidence

  • Exact PR HEAD general CI + static checks green; dedicated workflow on Python 3.11 and 3.12 green.
  • Independent source review for demo-only fictional identity safety and no accidental real credentials or private data.
  • Verify no co-install and no repo-source imports; compare only pinned published distributions.
  • Inspect README and instructions for false rollback or 0.6.0 parity claims; none intended.
  • Keep two independent external consumers as a separate required release gate. This in-repository demo is not independent consumer validation.

Existing Redis 7.4 published-package migration/rollback evidence remains the more extensive integration test. It handles selective cleanup, real persisted keys and package rollback, none of which this InMemory example claims to prove.

No deployment, PyPI publish, release tag, merge, Redis mutation or production-data access is requested. Refs #86 #88 and #48.

Final scope corrections (2026-11-21)

  • Platform claims now evidence-bounded: the script is designed for Windows/macOS/Linux but only Linux CPython 3.11/3.12 has end-to-end CI evidence. Do not assert Windows/macOS tested.
  • 0.6.0 refresh is explicit: after the new distribution is actually published, update pins, distribution assertions, comparator fixture, output/version text and user docs; re-run against exact published wheel/sdist and record hashes. The current 0.5.0 run cannot certify a future version.
  • Independent consumers: 0/2: this repo-contained demo does not satisfy either external exercise tracked by #91 and launch(0.6): first coordinated adoption campaign, public docs and verified migration demos #88.
  • Latest docs-only update is HEAD cb45ab0d0020ccceb4b410c856d91f04bce9c4e2; require all final-head workflows green before merge.

@agustin18
agustin18 marked this pull request as ready for review November 21, 2026 05:34
@agustin18
agustin18 merged commit d36a213 into stable Nov 21, 2026
35 checks passed
agustin18 added a commit that referenced this pull request Nov 21, 2026
Merge #89 and #90 without overwriting the #54 bounded backend/test/CI files. Keep draft pending an independent heap/concurrency audit.
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.

1 participant