Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions .changeset/changelog-ships-in-tarball.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
"@objectstack/account": patch
"@objectstack/cli": patch
"@objectstack/client": patch
"@objectstack/client-react": patch
"@objectstack/cloud-connection": patch
"@objectstack/connector-mcp": patch
"@objectstack/connector-openapi": patch
"@objectstack/connector-rest": patch
"@objectstack/connector-slack": patch
"@objectstack/console": patch
"@objectstack/core": patch
"@objectstack/driver-memory": patch
"@objectstack/driver-mongodb": patch
"@objectstack/driver-sql": patch
"@objectstack/driver-sqlite-wasm": patch
"@objectstack/embedder-openai": patch
"@objectstack/formula": patch
"@objectstack/hono": patch
"@objectstack/knowledge-memory": patch
"@objectstack/knowledge-ragflow": patch
"@objectstack/lint": patch
"@objectstack/mcp": patch
"@objectstack/metadata": patch
"@objectstack/metadata-core": patch
"@objectstack/metadata-fs": patch
"@objectstack/metadata-protocol": patch
"@objectstack/objectql": patch
"@objectstack/observability": patch
"@objectstack/platform-objects": patch
"@objectstack/plugin-approvals": patch
"@objectstack/plugin-audit": patch
"@objectstack/plugin-auth": patch
"@objectstack/plugin-dev": patch
"@objectstack/plugin-email": patch
"@objectstack/plugin-hono-server": patch
"@objectstack/plugin-pinyin-search": patch
"@objectstack/plugin-reports": patch
"@objectstack/plugin-security": patch
"@objectstack/plugin-sharing": patch
"@objectstack/plugin-webhooks": patch
"@objectstack/rest": patch
"@objectstack/runtime": patch
"@objectstack/sdui-parser": patch
"@objectstack/service-analytics": patch
"@objectstack/service-automation": patch
"@objectstack/service-cache": patch
"@objectstack/service-cluster": patch
"@objectstack/service-cluster-redis": patch
"@objectstack/service-datasource": patch
"@objectstack/service-i18n": patch
"@objectstack/service-job": patch
"@objectstack/service-knowledge": patch
"@objectstack/service-messaging": patch
"@objectstack/service-package": patch
"@objectstack/service-queue": patch
"@objectstack/service-realtime": patch
"@objectstack/service-settings": patch
"@objectstack/service-sms": patch
"@objectstack/service-storage": patch
"@objectstack/setup": patch
"@objectstack/studio": patch
"@objectstack/trigger-api": patch
"@objectstack/trigger-record-change": patch
"@objectstack/trigger-schedule": patch
"@objectstack/types": patch
"@objectstack/verify": patch
"create-objectstack": patch
"objectstack-vscode": patch
---

chore(packaging): CHANGELOG.md ships in every npm tarball (#4261)

The AGENTS.md post-task checklist requires breaking changesets to carry their
FROM → TO migration because "this text ships to consumers as `CHANGELOG.md`
inside the npm package and is what an upgrading agent greps after the tombstone
error." That delivery path was severed for 68 of the 69 publishable packages:
npm packs `package.json` / `README*` / `LICENSE*` unconditionally but — unlike
older npm versions — not `CHANGELOG.md`, and the canonical
`"files": ["dist", "README.md"]` whitelist never named it. Measured on npm
10.9.7: `npm pack --dry-run` on `@objectstack/types` shipped 3 files while its
70KB `CHANGELOG.md` stayed behind. Only `@objectstack/spec` listed it
explicitly.

The tombstone-error scenario is precisely the one where the repo is out of
reach — the upgrading agent has `node_modules` and nothing else — so the
migration text has to ride in the tarball. Every publishable package now
declares `CHANGELOG.md` in `files`, and the canonical whitelist is
`["dist", "README.md", "CHANGELOG.md"]`.

The other half is the gate: `check:published-files` gains a fifth invariant,
COMPLETE — a whitelist that fails to cover `CHANGELOG.md` fails the
always-required lint job, so the next package cannot silently sever the path
again. `@objectstack/spec`'s per-package EXTRA_ENTRIES exemption dissolves
into the canonical set.

Consumer-visible change: one more file per install (the package's changelog,
e.g. 70.8KB for `@objectstack/types`), and `grep -r "removed key"
node_modules/@objectstack/*/CHANGELOG.md` now finds the migration it was
promised.
3 changes: 2 additions & 1 deletion packages/adapters/hono/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/apps/account/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/apps/setup/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/apps/studio/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/client-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/cloud-connection/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/connectors/connector-mcp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
],
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
3 changes: 2 additions & 1 deletion packages/connectors/connector-openapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
],
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
3 changes: 2 additions & 1 deletion packages/connectors/connector-rest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
],
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
3 changes: 2 additions & 1 deletion packages/connectors/connector-slack/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
],
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
3 changes: 2 additions & 1 deletion packages/console/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"exports": {
"./package.json": "./package.json"
Expand Down
3 changes: 2 additions & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/create-objectstack/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/formula/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
3 changes: 2 additions & 1 deletion packages/lint/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/mcp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/metadata-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"scripts": {
"build": "tsup",
Expand Down
3 changes: 2 additions & 1 deletion packages/metadata-fs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"scripts": {
"build": "tsup",
Expand Down
3 changes: 2 additions & 1 deletion packages/metadata-protocol/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"scripts": {
"build": "tsup",
Expand Down
3 changes: 2 additions & 1 deletion packages/metadata/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"scripts": {
"build": "tsup",
Expand Down
3 changes: 2 additions & 1 deletion packages/objectql/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/observability/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/platform-objects/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/plugins/driver-memory/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/plugins/driver-mongodb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/plugins/driver-sql/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/plugins/driver-sqlite-wasm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
},
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
],
"engines": {
"node": ">=22.0.0"
Expand Down
3 changes: 2 additions & 1 deletion packages/plugins/embedder-openai/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
],
"files": [
"dist",
"README.md"
"README.md",
"CHANGELOG.md"
]
}
Loading
Loading