Skip to content

docs: add before-and-after forecast examples - #321

Merged
arminazimi merged 2 commits into
mainfrom
docs/123-forecast-examples
Nov 18, 2026
Merged

arminazimi merged 2 commits into
mainfrom
docs/123-forecast-examples

Conversation

@arminazimi

Copy link
Copy Markdown
Contributor

Implements the complete examples epic #123 in one PR.

Closes #141
Closes #142
Closes #143
Closes #223
Closes #168
Closes #240
Closes #257
Closes #190
Closes #271
Closes #279

What changed

  • Add three small before/after projects (Node.js, Python, and GitHub Actions), their six CLI-generated plain snapshots, and a linked walkthrough.
  • Apply the generated runtime and Action patches, then show the manual request and cgi.parse_header migrations. The intentionally old projects are inert fixtures, not Offing dependencies or live workflows.
  • Assert storm before and clear after using fixed replay dates, and enforce the 20-file cap without counting snapshots.

Workflow changes

  • Reason: Run the fixed-date forecast assertions in the existing PR test suite and rerun them in the dedicated examples workflow on relevant pushes to main.
  • Budget effect: +0 pull-request runner-minutes by the timeout-based budget (350 → 350); the assertions reuse the existing test jobs. The new, path-filtered post-merge job has a 5-minute timeout.

Quality bar

Reviewed against docs/QUALITY.md and the review rubric. No detector, registry, or public contract changes.

Checks CI cannot make

  • Tests added or updated for changed behavior
  • Changelog fragment added in changes/ — not applicable to docs and fixtures

Verification

  • npm run check
  • Ran the dedicated forecast assertions locally and compared all six CLI forecasts with their committed snapshots.
  • node --test dist/tests/forecast-snapshots.test.js dist/tests/examples-size.test.js dist/tests/examples-scanner-names.test.js
  • actionlint and zizmor --offline --persona=regular on the new workflow.
  • Ran the Python 3.13 upgrade check on both samples: one removed-API blocker before, none after.
  • Ran the repository self-scan against .offing-baseline.json: zero new findings.

@arminazimi
arminazimi merged commit a6a2cb2 into main Nov 18, 2026
30 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment