Back to Plate

package-api pack

docs/plans/templates/packs/package-api.md

53.0.63.1 KB
Original Source

package-api pack

Use this pack when work touches published packages, exports, public API shape, package boundaries, release artifacts, or package-level type/build behavior.

This pack owns the release-artifact decision. Do not create a separate changeset pack:

  • published package user-visible delta -> load changeset and add or update a .changeset/*.md file
  • registry-only work under apps/www/src/registry/** -> update docs/components/changelog.mdx
  • internal-only, docs-only, agent-only, or no user-visible delta from main -> record N/A: <reason>

Start Gates:

GateAppliesEvidence
Package/API pack selectedpendingpending
Public surface or package boundary identifiedpendingpending
Release artifact path selectedpendingChoose one: .changeset, registry changelog, or N/A: no published user-visible delta
changeset skill loaded when .changeset is requiredpendingpending
Barrel/export impact decision recordedpendingpending

Work Checklist:

  • Package/API pack: public API, package boundary, export, and release-artifact impact are recorded.
  • Package/API pack: release artifact matrix is applied: .changeset, registry changelog, or explicit no-artifact reason.
  • Package/API pack: .changeset work loads changeset and follows its package/version/prose rules.
  • Package/API pack: registry-only work updates docs/components/changelog.mdx instead of adding a package changeset.
  • Package/API pack: no-artifact decisions state why the diff has no published package user-visible delta from main.
  • Package/API pack: compatibility, migration, or hard-cut decision is explicit when public shape changes.
  • Package/API pack: package-owned typecheck/build/test proof is recorded or marked N/A with reason.
  • Package/API pack: generated barrels or release notes are updated when required.

Completion Gates:

GateAppliesRequired actionEvidence
Public API / package boundary proofpendingSource-audit public API, exports, and package boundary impactpending
Release artifact classificationpendingRecord whether the change is published package behavior/API/types/config/runtime, registry-only, or no published user-visible deltapending
Published package changesetpendingIf published package users see a delta, load changeset, add/update one .changeset/*.md per package, and prove no forbidden minor on @platejs/slate, @platejs/core, or platejspending
Registry changelogpendingIf the change is registry-only under apps/www/src/registry/**, update docs/components/changelog.mdx and do not add a package changesetpending
No release artifactpendingIf no artifact is needed, record the exact reason: internal-only, docs-only, agent-only, test-only, or no user-visible delta from mainpending
Package typecheck/build/testpendingRun owning package checks or record N/A with reasonpending
Barrel/export generationpendingRun pnpm brl when exports or exported file layout changed, otherwise N/Apending