Skip to content

Latest commit

 

History

History
132 lines (83 loc) · 3.53 KB

RELEASING.md

File metadata and controls

132 lines (83 loc) · 3.53 KB

Yes, pnpm and changesets work with workspace:* dependencies, but there are some important considerations to ensure everything functions smoothly.

How workspace:* Works in PNPM

When you use:

"@nodeboot/context": "workspace:*"

PNPM resolves @nodeboot/context from within your workspace instead of fetching it from the registry.

Key benefits of workspace:*:

  • Ensures local packages are always used.
  • Keeps all internal dependencies in sync.
  • Prevents version mismatches.

How Changesets Handles workspace:* Dependencies

Changesets will:

  1. Detect internal changes.
  2. Automatically bump dependent packages when a change is made to a workspace package.
  3. Ensure version updates propagate correctly.

Example

Let's say your monorepo has:

/packages/core (version 1.0.0)
/packages/app (depends on @nodeboot/context with "workspace:*")

If packages/core (which provides @nodeboot/context) gets a minor bump:

  • Changesets updates packages/core to 1.1.0.
  • Changesets ensures packages/app is updated to reference 1.1.0.

This prevents mismatches where one package is using an outdated version.

Best Practices for Using workspace:* with Changesets

1. Use workspace:^ Instead of workspace:*

workspace:* locks the dependency to any version inside the workspace, which can lead to unexpected behaviors.

✅ Instead, prefer:

"@nodeboot/context": "workspace:^"

This ensures that @nodeboot/context follows semver rules (^1.0.0 → allows updates to 1.x.x but not 2.x.x).

2. Ensure updateInternalDependencies is Set

In .changeset/config.json, confirm:

"updateInternalDependencies": "patch"

This makes sure internal dependencies always get updated when another workspace package changes.

3. Verify pnpm changeset version Behavior

Before publishing, run:

pnpm changeset version

Check that:

  • package.json versions are updated correctly.
  • workspace:* dependencies point to the new versions.

If needed, manually adjust the dependency versions before publishing.

4. Publish Correctly

If using a private monorepo, use:

pnpm changeset publish --tag beta

For public packages, run:

pnpm changeset publish

This ensures the latest workspace versions are published.

Summary of Commands

Command Description
pnpm changeset Creates a new changeset
pnpm changeset status Shows pending changesets
pnpm changeset version Applies version bumps
pnpm changeset publish Publishes updated packages

With this setup, pnpm + Changesets will properly manage versioning and publishing across your monorepo workspace.

Handy scripts

The Node-Boot parent package.jon provides some scripts to help in the release process by using pnpm + changesets.

Command Description
pnpm release:changeset Creates a new changeset for the monorepo workspaces by detecting changed packages automatically
pnpm release:status Shows pending changesets to be released
pnpm release:version Applies version bumps for changed packages in the monorepo, according to pending changesets
pnpm release:publish Publishes updated packages
pnpm release Applies version bumps for changed packages in the monorepo and publishes them to NPM