npm Publishing Setup

This repository publishes public scoped packages under @brightweblabs/* and the unscoped create-bw-app CLI package.

Requirements

1. Own or control the @brightweblabs npm scope.
2. Confirm the unscoped package name create-bw-app is available to publish.
3. Create an npm automation token.
4. Add NPM_TOKEN to the GitHub repository secrets.

First-time npm setup

1. Log into npm with the account that owns the @brightweblabs scope and will publish create-bw-app.
2. Confirm the scope exists and can publish public packages.
3. Confirm the unscoped CLI package name is available or already owned by the BrightWeb account.
4. Create an automation token in npm.
5. Add that token to GitHub as NPM_TOKEN.

Release flow

1. Add a changeset:

pnpm changeset

2. Merge the resulting changeset PR or your feature PR into main.
3. GitHub Actions creates or updates a release PR.
4. Merge the release PR.
5. GitHub Actions publishes the changed public packages, including create-bw-app, to npm.

Local publish testing

To dry-run release state locally:

pnpm release:check

To version packages locally:

pnpm release:version

To publish manually after authenticating with npm:

pnpm release:publish

Important note

Public npm publishing is separate from GitHub visibility. A public GitHub repo does not automatically grant ownership of the @brightweblabs npm scope or the unscoped create-bw-app package name.