Release-readiness documentation pass across all 42 packages by Copilot · Pull Request #1180 · objectstack-ai/objectstack

Copilot · 2026-04-17T12:59:11Z

Preparing the monorepo for formal npm publication: every @objectstack/* package needed consistent publishing metadata, a standardized README, and a corrected footprint in the docs site (which still claimed 27 packages — actual count is 42).

Standardization

New docs/internal/PACKAGE_README_TEMPLATE.md — canonical README structure, package.json publishing checklist, and pre-release PR gate. Single source of truth for future package additions.

`package.json` normalization (all 42)

Added missing description, keywords (≥3), full repository block with directory, homepage, bugs, publishConfig.access: public, files whitelist, engines.node, author.
Version-aligned @objectstack/service-tenant (0.1.0) and @objectstack/service-package (1.0.0) to the 4.0.4 release train.

READMEs

Authored packages/services/service-package/README.md (was missing entirely — release blocker).
Rewrote thin/stub READMEs to the canonical structure: core, rest, driver-memory, plugin-security, and all 7 adapters (express, fastify, hono, nestjs, nextjs, nuxt, sveltekit).
Pre-existing detailed READMEs (e.g. service-ai, service-storage, plugin-audit, runtime, spec, driver-sql, driver-turso) left intact to preserve their depth.

Docs site & root docs

content/docs/guides/packages.mdx — corrected package count (27 → 42), added a category summary table, added service-package and service-tenant entries.
content/docs/concepts/packages.mdx — corrected package count (25 → 42) and category breakdown.
Root README.md — Services table now lists all 12; Plugins table gains plugin-mcp-server; Codebase Metrics count 27 → 42.
CHANGELOG.md — release-prep entry.
RELEASE_NOTES.md — new v4.0.4 — Release Readiness section with full inventory and verification checklist.

Deferred (release pipeline)

content/docs/references/ regeneration via pnpm --filter @objectstack/spec gen:docs.
lychee link check and pnpm docs:build as part of release CI.

Example: normalized `package.json` tail

"repository": {
  "type": "git",
  "url": "https://github.com/objectstack-ai/framework.git",
  "directory": "packages/services/service-package"
},
"homepage": "https://objectstack.ai/docs",
"bugs": "https://github.com/objectstack-ai/framework/issues",
"keywords": ["objectstack", "service", "package", "registry", "marketplace"],
"publishConfig": { "access": "public" },
"files": ["dist", "README.md"],
"engines": { "node": ">=18.0.0" }

…son publishing metadata Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/31298df6-e8fb-4b22-9182-02fb8a2606b3 Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>

…, root README) + Phase 4 (build/test green) Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/31298df6-e8fb-4b22-9182-02fb8a2606b3 Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>

vercel · 2026-04-17T12:59:16Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
objectstack-demo	Ready	Preview, Comment	Apr 17, 2026 0:59am
spec	Ready	Preview, Comment	Apr 17, 2026 0:59am

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Prepares the monorepo for npm release readiness by standardizing package publishing metadata and aligning documentation to reflect the full 42-package inventory.

Changes:

Normalized many package.json files with consistent publishing metadata (repo/homepage/bugs/keywords/files/engines/publishConfig).
Added/rewrote several package READMEs to a canonical structure and added a new internal README template/checklist.
Updated docs site pages + root docs/release notes/changelog to reflect 42 packages and include missing package entries.

Reviewed changes

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

Show a summary per file

File	Description
packages/vscode-objectstack/package.json	Updates repository metadata; adds engines.node, keywords, publish/files metadata.
packages/types/package.json	Adds npm publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/spec/package.json	Adds repository/homepage/bugs metadata for npm publication.
packages/services/service-tenant/package.json	Aligns version to 4.0.4 and adds homepage/bugs/engines.node.
packages/services/service-storage/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-realtime/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-queue/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-package/package.json	Aligns version to 4.0.4 and adds publishing metadata.
packages/services/service-package/README.md	New canonical README for service-package (release blocker removal).
packages/services/service-job/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-i18n/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-feed/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-cache/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-automation/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-analytics/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/services/service-ai/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/runtime/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/rest/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/rest/README.md	Rewrites README to canonical structure incl. install/quickstart/exports/config.
packages/plugins/plugin-setup/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-security/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-security/README.md	Rewrites README to canonical structure with clarified behavior/exports.
packages/plugins/plugin-msw/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-mcp-server/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-hono-server/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-dev/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-auth/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/plugin-audit/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/driver-turso/package.json	Adds publishing metadata (author/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/driver-sql/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/driver-memory/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/plugins/driver-memory/README.md	Rewrites README to canonical structure + adds persistence usage.
packages/objectql/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/metadata/package.json	Adds repository/homepage/bugs/publishConfig/engines metadata.
packages/create-objectstack/package.json	Adds repository/homepage/bugs/publishConfig/files/engines metadata.
packages/core/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/core/README.md	Rewrites README to canonical structure with lifecycle/export tables.
packages/client/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/client-react/package.json	Adds publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/cli/package.json	Adds repository/homepage/bugs/publishConfig/files/engines metadata.
packages/adapters/sveltekit/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/sveltekit/README.md	Rewrites README to canonical structure with examples/exports.
packages/adapters/nuxt/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/nuxt/README.md	Rewrites README to canonical structure + usage guidance.
packages/adapters/nextjs/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/nextjs/README.md	Rewrites README to canonical structure incl. server actions/discovery handler.
packages/adapters/nestjs/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/nestjs/README.md	Rewrites README to canonical structure + DI token guidance.
packages/adapters/hono/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/hono/README.md	Rewrites README to canonical structure + CORS/edge notes.
packages/adapters/fastify/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/fastify/README.md	Rewrites README to canonical structure + plugin/decorator usage.
packages/adapters/express/package.json	Adds description + publishing metadata (keywords/repo/homepage/bugs/publishConfig/files/engines).
packages/adapters/express/README.md	Rewrites README to canonical structure + middleware mode guidance.
docs/internal/PACKAGE_README_TEMPLATE.md	Adds canonical README structure + package.json checklist for maintainers.
content/docs/guides/packages.mdx	Fixes package count (27→42) and adds category summary + missing services.
content/docs/concepts/packages.mdx	Fixes package count (25→42) and updates category breakdown.
RELEASE_NOTES.md	Adds v4.0.4 release-readiness section + checklist + inventory.
README.md	Updates package tables and metrics to include all 42 packages.
CHANGELOG.md	Adds release-readiness entry covering metadata/doc alignment.

Comments suppressed due to low confidence (1)

packages/services/service-tenant/package.json:1

This PR aims for consistent publishing metadata, but author here is "ObjectStack Team" while many other packages in the diff use "ObjectStack" (and the internal checklist calls for "ObjectStack"). Aligning author across packages will avoid unnecessary diff churn later and keep npm listing metadata uniform.

+| `homepage` | Package landing page on docs site | `"https://objectstack.ai/docs/packages/core"` |
+| `bugs` | Issues URL | `"https://github.com/objectstack-ai/framework/issues"` |


+}
+```
+
+### Canonical `files` whitelist


+  "files": [
+    "dist",
+    "README.md"
+  ],


@@ -1,43 +1,48 @@
 # @objectstack/rest


Copilot AI and others added 2 commits April 17, 2026 12:22

Copilot AI assigned Copilot and hotlong Apr 17, 2026

Copilot created this pull request from a session on behalf of xuyushun441-sys April 17, 2026 12:59

View session

hotlong marked this pull request as ready for review April 17, 2026 12:59

Copilot AI review requested due to automatic review settings April 17, 2026 12:59

hotlong merged commit c87c335 into main Apr 17, 2026
3 checks passed

Copilot started reviewing on behalf of hotlong April 17, 2026 13:00

View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

hotlong mentioned this pull request Aug 6, 2026

[PM] 分片分工登记表 — 谁在管哪个仓库的队列 #4604

Closed

claude Bot mentioned this pull request Aug 6, 2026

[PM seat] repo:cloud#1 — 🟢 baozhoutao · session_01FSg7JRUiTPo8GrgT38tAWP #6026

Open

Navigation Menu

Repository navigation

Release-readiness documentation pass across all 42 packages - #1180

Release-readiness documentation pass across all 42 packages#1180
hotlong merged 2 commits into
mainfrom
copilot/update-package-docs

Copilot AI commented Apr 17, 2026

Uh oh!

vercel Bot commented Apr 17, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		\| `homepage` \| Package landing page on docs site \| `"https://objectstack.ai/docs/packages/core"` \|
		\| `bugs` \| Issues URL \| `"https://github.com/objectstack-ai/framework/issues"` \|

Conversation

Copilot AI commented Apr 17, 2026

Standardization

package.json normalization (all 42)

READMEs

Docs site & root docs

Deferred (release pipeline)

Example: normalized package.json tail

Uh oh!

vercel Bot commented Apr 17, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`package.json` normalization (all 42)

Example: normalized `package.json` tail