# Add drizzle-kit announcement manifest and schema doc Adds the drizzle-kit/announcements/ directory: a static manifest (v1.json) and a README documenting its schema and update runbook. | | | | --- | --- | | Status | MERGED · CHECKS FAILING | | Source | github:drizzle-team/drizzle-orm#6049 | | Original | https://github.com/drizzle-team/drizzle-orm/pull/6049 | | Workspace | Showcase | | Tags | github, code, docs, json, gitignore | ## What it does **Most of this change is one file: README.md holds 91% of the edited lines.** 3 files changed across 3 areas of drizzle-team/drizzle-orm, 179 added and 0 removed. Adds the drizzle-kit/announcements/ directory: a static manifest (v1.json) and a README documenting its schema and update runbook. **Diagram: Where the change landed. Node size is not to scale; the line counts are exact.** - drizzle-orm (3 files, 179 lines) [accent] - Docs (1 file, 162 lines) [neutral] - Config (1 file, 16 lines) [bad] - Source (1 file, 1 lines) [accent] - README.md (+162 −0) [bad] - drizzle-orm -> Docs - drizzle-orm -> Config - drizzle-orm -> Source - Docs -> README.md : heaviest - **Heaviest file.** drizzle-kit/announcements/README.md, +162 −0, which is 91% of the change. - **No test changed.** 1 source file changed with no accompanying test edit. - **Configuration touched.** v1.json. Config changes are small in the diff and large in effect. - **CI is red.** 2 checks are failing, so the change is not currently in a mergeable state. ## How it works **The largest single edit is in README.md.** Quoted verbatim from the diff. This is the biggest hunk by changed lines, which is where a reviewer's attention usually belongs first. **Diagram: Source files matched to test files by filename. A name-based match, so treat it as a prompt to look rather than as proof.** - NO TEST CHANGED (1) - .gitignore (+1 −0) [bad] - TEST CHANGED TOO (0) - no source file paired [bad] ```markdown @@ -0,0 +1,162 @@ +# Announcement manifest + +This directory is the source of truth for drizzle-kit's announcement manifest. +It is served over jsDelivr from the `main` branch at: + +``` +https://cdn.jsdelivr.net/gh/drizzle-team/drizzle-orm@main/drizzle-kit/announcements/v1.json +``` + +The file is **not** shipped in the npm tarball and **not** copied into `dist` — +editing `v1.json` and merging to `main` is the entire publish pipeline. + +A breaking schema change ships as a sibling `v2.json`; old drizzle-kit binaries +keep reading `v1.json` forever, so there is no in-file schema version field to +bump — the filename is the compatibility mechanism. + +## Schema + +```ts +type Manifest = { + disabled?: boolean; ``` _drizzle-kit/announcements/README.md, +162 −0. The largest hunk in the largest file._ ## File map **Every file this change touches, heaviest first.** Role is inferred from the path and risk from the path and the line count. Neither was read from the code. | File | Role | Change | Risk | | --- | --- | --- | --- | | `drizzle-kit/announcements/README.md` | documentation | added, +162 −0 | none | | `drizzle-kit/announcements/v1.json` | application code | added, +16 −0 | low | | `drizzle-kit/.gitignore` | application code | modified, +1 −0 | low | ## Receipts **Where each number above comes from.** All of it is arithmetic over the file list and the check results, so it can be recomputed from the source. - **Claim.** 3 files changed, +179 −0. - Evidence: drizzle-kit/announcements/README.md (+162 −0); drizzle-kit/announcements/v1.json (+16 −0); drizzle-kit/.gitignore (+1 −0) - Where: https://github.com/drizzle-team/drizzle-orm/pull/6049 - **Claim.** README.md carries 91% of the changed lines. - Evidence: 162 of 179 changed lines - Where: drizzle-kit/announcements/README.md - **Claim.** It arrived as 1 commit. - Evidence: Add drizzle-kit announcement manifest and schema doc - Where: commit f9fc5bf - **Claim.** CI reports 2 failing of 30. - Evidence: run-feature / test (singlestore-custom) - Where: CI check: run-feature / test (singlestore-custom) ## Where to attack **What the shape of this diff suggests looking at first.** These come from structure alone: which areas were touched, what was not touched alongside them, and what CI says. None of them is a judgement about the code. - **run-feature / test (singlestore-custom) is failing** (high) - No summary was published for this check. - Mitigation: Read the check output before anything else here matters. - **run-feature / attw (drizzle-seed) is failing** (high) - No summary was published for this check. - Mitigation: Read the check output before anything else here matters. - **Configuration changed** (high) - drizzle-kit/announcements/v1.json changed. A config edit is usually a handful of lines and decides behaviour for an entire environment, so diff size is a poor guide to its blast radius. - Mitigation: Check what reads each of these values, and in which environments they differ. - **Source changed with no test changed** (medium) - 1 source file changed and no test file moved with them. Existing tests may already cover this, or they may not; the diff cannot say which. - Mitigation: Confirm whether coverage already exists for the changed paths before approving. - **README.md dominates the diff** (medium) - 91% of the changed lines are in one file, so reviewing the other 2 files carefully still leaves most of the change unread. - Mitigation: Budget the review time accordingly. ## Merge order **A reading order for the review, not a deployment plan.** Ordered by how expensive each part is to get wrong, which is a structural property rather than an informed one. 1. **Read the failing check first.** run-feature / test (singlestore-custom) is red. Everything else is provisional until that is understood. 2. **Review the configuration changes.** v1.json. Smallest diff, widest effect. 3. **Then README.md.** The largest single file in the change, +162 −0. 4. **Decide whether a test is needed.** Nothing in this change adds or edits one. ## What this brief could not check - No language model read this change. Every statement here is computed from file paths, line counts, and CI status, so it describes the shape of the diff and not what the diff means. - No test file changed, so nothing here is evidence that the change works.