Skip to content

Commit f4fe593

Browse files
committed
docs: update documentation for npm trusted publishers
- Update AGENTS.md to mention trusted publishers and changeset workflow - Update versioning-with-npm.mdc to clarify changesets as primary method - Add notes about OIDC authentication and no tokens required
1 parent f8916bc commit f4fe593

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

.cursor/rules/versioning-with-npm.mdc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You are an expert release manager for a Yarn 4 monorepo who uses the npm CLI for
88
- Treat new components and minor fixes as patch releases when they are additive and low-risk.
99
- Reserve minor/major only for notable feature waves or breaking changes.
1010

11-
Note: While the repo supports Changesets for broader release coordination, this rule documents the npm CLI flow for quick iterations.
11+
Note: The primary release workflow uses Changesets (`yarn changeset` → `yarn changeset version` → automatic CI/CD publish). This rule documents the npm CLI flow for quick iterations when bypassing changesets.
1212

1313
## What Counts As “Small”
1414
- Additive components (new UI or form wrappers) without breaking changes
@@ -47,7 +47,8 @@ Guidelines:
4747

4848
## Open PR and Merge
4949
- Push your branch and open a PR.
50-
- When the PR merges into `main`, GitHub CI publishes the package. No manual tagging or `npm publish` needed.
50+
- When the PR merges into `main`, GitHub CI automatically publishes the package using npm trusted publishers (OIDC). No manual tagging or `npm publish` needed, and no npm tokens required.
51+
- **Note:** The release workflow uses [npm trusted publishers](https://docs.npmjs.com/trusted-publishers) for secure, tokenless publishing. Ensure the trusted publisher is configured on npmjs.com for the package.
5152

5253
## Minor / Major (When Needed)
5354
- Minor: larger feature sets or notable additions across multiple components

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@
3636
- PRs: clear description, linked issues, screenshots or Storybook links, notes on testing.
3737
- Required checks: `yarn lint` passes; build succeeds; tests updated/added.
3838
- Versioning: when changing published package(s), add a Changeset (`yarn changeset`) before merge.
39+
- Publishing: Releases are automatically published via CI/CD using [npm trusted publishers](https://docs.npmjs.com/trusted-publishers) (OIDC). No npm tokens required. See README.md for setup instructions.
3940

4041
## Security & Configuration
4142
- Node `22.9.0` (`.nvmrc`) and Yarn 4 (`packageManager`).
4243
- Do not commit secrets. Keep large artifacts out of VCS (`dist`, `node_modules`).
44+
- Publishing uses npm trusted publishers (OIDC) - no long-lived tokens needed.
4345
- PR previews for Storybook are published via GitHub Pages; verify links in PR comments.
4446

4547
## Cursor Rules Review
@@ -48,7 +50,7 @@
4850
- `.cursor/rules/form-component-patterns.mdc`: Remix Hook Form + Zod wrappers, errors, server actions.
4951
- `.cursor/rules/storybook-testing.mdc`: Storybook play tests, router stub decorator, local/CI flows.
5052
- `.cursor/rules/monorepo-organization.mdc`: Imports/exports, package boundaries, Turbo/Vite/TS paths.
51-
- `.cursor/rules/versioning-with-npm.mdc`: npm CLI version bumps (patch-first), CI publishes on merge.
53+
- `.cursor/rules/versioning-with-npm.mdc`: npm CLI version bumps for quick iterations (patch-first). Primary workflow uses Changesets with automatic CI/CD publishing via npm trusted publishers.
5254

5355
## Agent OS
5456

0 commit comments

Comments
 (0)