Skip to content

docs: consolidate oss-packages adrs#4151

Merged
joanagmaia merged 4 commits into
mainfrom
chore/update-oss-packages-adrs
May 27, 2026
Merged

docs: consolidate oss-packages adrs#4151
joanagmaia merged 4 commits into
mainfrom
chore/update-oss-packages-adrs

Conversation

@joanagmaia
Copy link
Copy Markdown
Contributor

@joanagmaia joanagmaia commented May 27, 2026

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-packages domain. 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:

  • Added docs/adr/0001-oss-packages-design-decisions.md as the single living record for all design decisions in the oss-packages domain, covering database architecture, ingestion strategies, data ownership, and open questions.
  • Removed the previous ADR, 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):

  • Defined partitioning and placement for all major tables, including rationale and trade-offs for query performance and scalability.
  • Standardized worker architecture and ingestion strategies for each data source (npm, Maven, GitHub, Docker Hub, OSV), including data flow, update cadence, and conflict-avoidance rules.
  • Established explicit data ownership and provenance for all major tables and columns, with clear boundaries between sources and a process for handling schema evolution.
  • Documented open questions and deferred decisions (e.g., critical vulnerability flag semantics, Sonatype API access), ensuring future changes are tracked in one place.

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.md now indexes only this ADR.

Reviewed by Cursor Bugbot for commit 4567272. Bugbot is set up for automated code reviews on this repo. Configure here.

Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI review requested due to automatic review settings May 27, 2026 17:37
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ Jira Issue Key Missing

Your PR title doesn't contain a Jira issue key. Consider adding it for better traceability.

Example:

  • feat: add user authentication (CM-123)
  • feat: add user authentication (IN-123)

Projects:

  • CM: Community Data Platform
  • IN: Insights

Please add a Jira issue key to your PR title.

Copy link
Copy Markdown
Contributor

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

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.md and docs/adr/0002-packages-worker-architecture.md.
  • Update docs/adr/README.md index 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.

Comment thread docs/adr/0001-oss-packages-design-decisions.md Outdated
Comment thread docs/adr/0001-oss-packages-design-decisions.md Outdated
Comment thread docs/adr/0001-oss-packages-design-decisions.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Joana Maia <jmaia@contractor.linuxfoundation.org>
Copilot AI review requested due to automatic review settings May 27, 2026 17:41
joanagmaia and others added 2 commits May 27, 2026 18:41
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>
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@joanagmaia joanagmaia merged commit 2f3f03d into main May 27, 2026
12 checks passed
@joanagmaia joanagmaia deleted the chore/update-oss-packages-adrs branch May 27, 2026 17:48
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