Skip to content

README.md

41 lines · 1.9 KB · Markdown
Raw

@kentcdodds/lineage

Intent

Give Kent an interactive, commit-level look at countable lines in kentcdodds/kody — not use-kody, which has no application source. The app should ignore generated output even when that output is committed (Wrangler types, lockfiles, generated/ trees, Linguist-generated paths, and @generated / DO NOT EDIT headers), store the series in this package's storage, and stay useful offline as an installable PWA. Success is a graph you can slice by time, language, and type (source / tests / docs), with linked commits and short labels that open a longer narrative.

What it does

  • Hosted chart app with cumulative, added/removed, and net-per-commit modes
  • Backfill and ingest helpers write commit buckets into packageStorage()
  • GitHub push webhook fills new main commits as they land
  • Commentary helpers attach short labels and longer narratives to commits
  • Status / series / inspect helpers for agents and the UI to share the same numbers

Prerequisites / setup

  1. Tracked repo defaults to kentcdodds/kody on main (override via ./settings without republishing).
  2. User secret githubLocWebhookSecret — HMAC for the github-push webhook (x-hub-signature-256). Do not paste the secret value in chat.
  3. Depends on @kentcdodds/github for GitHub API access used by ingest / backfill.
  4. Prefer event-driven webhook ingest; the backfill-missing cron (every 30m, America/Denver) is catch-up only — do not disable live webhooks or jobs.
  5. Hosted app: https://kentcdodds.kody.run/packages/lineage
  6. Agents: see AGENTS.md for import paths and smoke checks.

Done when

  • Hosted app loads and shows a countable series for kentcdodds/kody
  • ./status reports stored commits; webhook or backfill fills gaps
  • Generated files stay out of countable totals; commentaries open from chart labels