Skip to content

docs(deltagraph): add GA readiness checklist#342

Open
genezhang wants to merge 2 commits into
mainfrom
docs/deltagraph-ga-readiness
Open

docs(deltagraph): add GA readiness checklist#342
genezhang wants to merge 2 commits into
mainfrom
docs/deltagraph-ga-readiness

Conversation

@genezhang
Copy link
Copy Markdown
Owner

Summary

  • New docs/deltagraph/GA_READINESS.md — parking-spot doc for the work between code-complete (0.6.7-dev, Phase 4 merged) and 0.7.0 GA
  • Gates: live-warehouse correctness, perf baseline, soak, failure modes, concurrency
  • Should-land-before-GA: OAuth M2M, EXTERNAL_LINKS disposition, observability hooks
  • Explicit GA exit criteria (LDBC pass, 24h soak, OAuth + EXTERNAL_LINKS, documented failure modes, external user run-through)
  • Section on what local Apache Spark + Delta OSS can substitute for vs what it cannot — with three setup options ranked by fidelity (pyspark+pytest recommended)
  • Out-of-scope items called out (MERGE writes, SQL AST layer, CALL subqueries)

Docs-only, no code changes. Force-added past the docs/ gitignore (same pattern as the existing QUICKSTART.md).

Test plan

  • No code touched — nothing to test beyond markdown rendering
  • Reviewer skim for accuracy against current state of STATUS.md / CHANGELOG.md / QUICKSTART.md

🤖 Generated with Claude Code

Captures the gates between current code-complete state (0.6.7-dev, Phase 4
merged) and 0.7.0 GA: live-warehouse correctness, perf baseline, soak,
failure modes, concurrency, plus OAuth M2M / EXTERNAL_LINKS / observability.

Also documents what local Apache Spark + Delta OSS can substitute for
(SQL correctness, LDBC functional diff) and what it cannot (Statement
Execution REST, auth, lifecycle, EXTERNAL_LINKS, Photon).

Parking spot — pick up when a Databricks environment is available.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 17, 2026 05:18
github-actions[bot]
github-actions Bot previously approved these changes May 17, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This docs-only PR adds a DeltaGraph GA readiness checklist that captures validation gates, pre-GA feature work, local Spark substitution guidance, and explicit out-of-scope items for the path from 0.6.7-dev to 0.7.0 GA.

Changes:

  • Adds GA gating criteria for correctness, performance, soak, failure modes, and concurrency.
  • Defines pre-GA feature expectations around OAuth M2M, EXTERNAL_LINKS, and observability.
  • Documents local Spark validation options and GA out-of-scope items.

Comment thread docs/deltagraph/GA_READINESS.md Outdated
@@ -0,0 +1,175 @@
# DeltaGraph — GA Readiness Checklist

Engineering port is code-complete through Phase 4 (PRs #316–#341, all merged
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b965869 — aligned with CHANGELOG: engineering PRs #316-#338, plus follow-ups #339/#340/#341 for CHANGELOG sync, optional catalog: YAML field, and README mention.

Comment thread docs/deltagraph/GA_READINESS.md Outdated

### 1. Correctness against a live warehouse

- LDBC SNB sweep (`bi-1..18`, `complex-1..14`, `short-1..7`) on Delta tables
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b965869 — gate now reads bi-1..15 and bi-17..18, with bi-16 explicitly excluded and a back-reference to the out-of-scope CALL section.


## GA exit criteria (the actual bar)

1. LDBC SNB suite passes on Databricks with documented per-query times
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b965869 — exit criterion now reads '(excluding bi-16 — see CALL subquery note below)'.

Comment thread docs/deltagraph/GA_READINESS.md Outdated
Comment on lines +162 to +163
- **MERGE / write support** — DeltaGraph is read-only by design. QUICKSTART
documents this; no committed timeline for changing it.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b965869 — MERGE moved out of the out-of-scope list into a should-land-before-GA bullet, matching what STATUS.md/CHANGELOG.md actually say ('pending before Databricks GA'). Also flagged the QUICKSTART wording mismatch ('not on the current roadmap') for reconciliation when MERGE lands.

Comment thread docs/deltagraph/GA_READINESS.md Outdated
Comment on lines +153 to +156
`benchmarks/social_network/schemas/social_benchmark.yaml` already defines
the smallest LDBC-style shape we use. A seed script that materializes
the same data as both ClickHouse tables and Delta tables would let us run
the diff in CI without external dependencies.
Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in b965869 — seeding section now points at benchmarks/ldbc_snb/schemas/ldbc_snb_complete.yaml (canonical LDBC superset with Person/Comment/Forum/Tag/Place/etc.) and explicitly notes that social_benchmark.yaml is dev-only sanity coverage, not LDBC.

- PR provenance: align with CHANGELOG (engineering PRs #316#338,
  follow-ups #339/#340/#341 noted separately) instead of claiming the
  full range was all engineering work
- Correctness gate + exit criterion: exclude bi-16 explicitly (blocked
  on CALL subqueries; was an impossible gate as written)
- MERGE: move out of "explicitly out of scope" into a should-land-before-GA
  bullet, matching STATUS.md / CHANGELOG.md which both list MERGE as
  pending before Databricks GA. Flag the QUICKSTART wording mismatch
  for reconciliation when MERGE lands.
- Local-dataset seeding: point at benchmarks/ldbc_snb/schemas/ for the
  actual LDBC label set; clarify that social_benchmark.yaml is dev-only
  sanity coverage, not LDBC

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@genezhang
Copy link
Copy Markdown
Owner Author

Pushed b965869 with all 5 fixes. Re-requesting Copilot review per HOUSE RULE (≥5 comments).

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.

2 participants