Skip to content

Commit 8debc2d

Browse files
committed
docs: clarify changeset publish workflow uses npm
1 parent 1bdf638 commit 8debc2d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,19 @@ yarn test
191191

192192
#### Step 4: Publish to npm
193193

194-
Publish the package to npm:
194+
Publish the package to npm using changesets:
195195

196196
```bash
197197
yarn release
198198
```
199199

200-
This command:
201-
- Runs `yarn build` (via `prepublishOnly` hook)
202-
- Publishes `@lambdacurry/forms` to npm using `changeset publish`
200+
This command runs `changeset publish`, which:
201+
- Runs `yarn build` (via `prepublishOnly` hook in package.json)
202+
- Publishes `@lambdacurry/forms` to npm (uses npm under the hood)
203+
- Creates git tags for the release
204+
- Requires you to be logged into npm (`npm login`)
205+
206+
**Note:** `changeset publish` uses npm CLI internally, so you must be authenticated with npm. The changeset system handles versioning, changelog generation, and publishing all in one workflow.
203207

204208
#### Step 5: Commit and Push
205209

@@ -211,9 +215,9 @@ git commit -m "chore(release): publish vX.Y.Z"
211215
git push origin main
212216
```
213217

214-
### Quick Release (No Changesets)
218+
### Alternative: Direct npm Publish (Without Changesets)
215219

216-
If you just need to bump the version without changesets (e.g., for a hotfix), you can use npm directly:
220+
If you need to publish without using changesets (e.g., for a hotfix), you can use npm directly:
217221

218222
```bash
219223
# From the packages/components directory
@@ -225,6 +229,8 @@ yarn workspace @lambdacurry/forms build
225229
npm publish --workspace=packages/components
226230
```
227231

232+
**Note:** This bypasses the changeset workflow, so you'll need to manually update the CHANGELOG.md if you want to document the release.
233+
228234
### Troubleshooting
229235

230236
- **"Not logged in" error**: Run `npm login` and verify with `npm whoami`

0 commit comments

Comments
 (0)