docs: consolidate oss-packages adrs#4151
Conversation
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
|
Your PR title doesn't contain a Jira issue key. Consider adding it for better traceability. Example:
Projects:
Please add a Jira issue key to your PR title. |
There was a problem hiding this comment.
Pull request overview
Documentation-only reorganization that replaces two separate accepted ADRs (0001-packages-database.md, 0002-packages-worker-architecture.md) with a single living ADR consolidating all oss-packages design decisions (DB placement, worker architecture, ingestion strategies, write semantics, provenance, OSV, deps.dev ownership, downloads tiering, open questions). The ADR index is updated accordingly. No runtime code changes.
Changes:
- Add new consolidated living ADR
docs/adr/0001-oss-packages-design-decisions.md. - Delete
docs/adr/0001-packages-database.mdanddocs/adr/0002-packages-worker-architecture.md. - Update
docs/adr/README.mdindex to reference only the new ADR.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/adr/0001-oss-packages-design-decisions.md | New living ADR consolidating oss-packages design decisions. |
| docs/adr/0001-packages-database.md | Removed; content folded into new ADR. |
| docs/adr/0002-packages-worker-architecture.md | Removed; content folded into new ADR. |
| docs/adr/README.md | Index updated to list only ADR-0001 with living status. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
This pull request replaces the previous ADR for the packages database with a new, comprehensive, and "living" architectural decision record (ADR-0001) that documents all major design decisions for the
oss-packagesdomain. The new ADR consolidates database, ingestion, worker, and data ownership strategies into a single, continuously updated document, superseding the prior single-purpose ADR.The most important changes are:
ADR and Documentation Overhaul:
docs/adr/0001-oss-packages-design-decisions.mdas the single living record for all design decisions in theoss-packagesdomain, covering database architecture, ingestion strategies, data ownership, and open questions.docs/adr/0001-packages-database.md, which focused only on the database separation decision, consolidating its content into the new, broader ADR.Key Architectural and Process Decisions (as captured in the new ADR):
Note
Low Risk
Documentation-only change; no runtime, schema, or deployment behavior is modified.
Overview
Replaces two accepted ADRs (
0001-packages-database,0002-packages-worker-architecture) with a single living ADR-0001 that records the full oss-packages design in one place.Beyond what the removed ADRs covered, the new doc adds universe/criticality (deps.dev BigQuery →
packages_universe), concurrent write rules per table, repo provenance (package_repos, canonical URLs), OSV ingestion semantics, per-source npm/Maven/GitHub/Docker strategies, a deps.dev column ownership matrix, Tier 2 vs Tier 3 download storage, and an open questions section.docs/adr/README.mdnow indexes only this ADR.Reviewed by Cursor Bugbot for commit 4567272. Bugbot is set up for automated code reviews on this repo. Configure here.