Skip to content

Update publishing-to-npm.mdx #1524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 28, 2025
Merged

Update publishing-to-npm.mdx #1524

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions fern/products/sdks/overview/typescript/publishing-to-npm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Choose how you want to authenticate with npmjs when publishing.
OIDC-based publishing (also known as "trusted publishing") is the most secure way to publish. With OIDC, you don't need to manage authentication tokens - npmjs trusts your GitHub repository to publish directly.

<Info title="Prerequisites">
- Fern TypeScript SDK generator version `3.12.0` or later
- Fern TypeScript SDK generator version `3.12.2` or later
- Fern CLI version `0.94.0` or later (only required for local generation with `--local`)
</Info>

Expand All @@ -136,7 +136,7 @@ OIDC-based publishing (also known as "trusted publishing") is the most secure wa
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/> # Must be 3.12.0 or later
version: <Markdown src="/snippets/version-number-ts.mdx"/> # Must be 3.12.2 or later
output:
location: npm
package-name: your-package-name
Expand Down Expand Up @@ -335,10 +335,10 @@ Select the approach that fits your situation:
<AccordionGroup>
<Accordion title="Path 1: Upgrade your generator (Recommended)">

This is the easiest path if you can upgrade to version 3.12.0 or later of the TypeScript SDK generator.
This is the easiest path if you can upgrade to version 3.12.2 or later of the TypeScript SDK generator.

**When to use this path:**
- You're able to upgrade to Fern TypeScript SDK generator version 3.12.0 or later
- You're able to upgrade to Fern TypeScript SDK generator version 3.12.2 or later
- You haven't `.fernignore`'d your CI workflow file

<Steps>
Expand All @@ -359,14 +359,14 @@ This is the easiest path if you can upgrade to version 3.12.0 or later of the Ty

<Step title="Update your generators.yml">

Change the `output.token` field from `${NPM_TOKEN}` to `OIDC` and ensure you're using version `3.12.0` or later:
Change the `output.token` field from `${NPM_TOKEN}` to `OIDC` and ensure you're using version `3.12.2` or later:

```yaml title="generators.yml"
groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/version-number-ts.mdx"/> # Must be 3.12.0 or later
version: <Markdown src="/snippets/version-number-ts.mdx"/> # Must be 3.12.2 or later
output:
location: npm
package-name: your-package-name
Expand Down Expand Up @@ -534,7 +534,7 @@ If your workflow continues using the old token-based authentication:

- Verify you've removed the `npm config set` line and the `env: NPM_TOKEN` block from the publish step
- Check that npm CLI version 11.5.1+ is installed (add the update npm step)
- Ensure you're using generator version 3.12.0 or later (if using Path 1)
- Ensure you're using generator version 3.12.2 or later (if using Path 1)
- When using `--local` generation, you need to use Fern CLI version 0.94.0 or later

</Accordion>
Expand Down