diff --git a/fern/products/sdks/overview/typescript/assets/npm-packages.png b/fern/products/sdks/overview/typescript/assets/npm-packages.png new file mode 100644 index 000000000..8ab6b5356 Binary files /dev/null and b/fern/products/sdks/overview/typescript/assets/npm-packages.png differ diff --git a/fern/products/sdks/overview/typescript/publishing-to-npm.mdx b/fern/products/sdks/overview/typescript/publishing-to-npm.mdx index 43c90403a..dd501f6df 100644 --- a/fern/products/sdks/overview/typescript/publishing-to-npm.mdx +++ b/fern/products/sdks/overview/typescript/publishing-to-npm.mdx @@ -3,7 +3,13 @@ title: Publishing to NPM description: How to publish the Fern Typescript SDK to npm. --- -Publish your public-facing Fern Typescript SDK to the [npm registry](https://www.npmjs.com/). Once you've followed the steps on this page to connect your npm account to your SDK, Fern will automatically publish the latest version of your SDK. +Publish your public-facing Fern Typescript SDK to the [npm +registry](https://www.npmjs.com/). After following the steps on this page, +you'll have a versioned package published on npm. + + + Creating NPM Automation Token + This guide assumes that you already have an initialized `fern` folder on your local machine. If you don’t, run `fern init`. See [TypeScript Quickstart](quickstart.mdx) for more details. @@ -21,7 +27,7 @@ Publish your public-facing Fern Typescript SDK to the [npm registry](https://www Navigate to your `generators.yml` on your local machine. Your `generators.yml` lives inside of your `fern` folder and contains all the configuration for your Fern generators. - In order to generate the SDK, add the generator to your `generators.yml` using the `fern ` command: + Add a new generator to `generators.yml`: ```bash @@ -29,9 +35,10 @@ Publish your public-facing Fern Typescript SDK to the [npm registry](https://www ``` Once the command completes, you'll see a new group created in your `generators.yml`: - + ```yaml {2-7} - groups: + groups: + local: ... ts-sdk: generators: @@ -93,7 +100,7 @@ groups: location: npm package-name: your-package-name config: - namespaceExport: your-client-name + namespaceExport: YourClientName # must be a valid JavaScript/TypeScript identifier ``` @@ -216,7 +223,7 @@ ts-sdk: Regenerate your SDK and publish it on npm: ```bash - fern generate --version + fern generate --group ts-sdk --version ``` Local machine output will verify that the release is pushed to your repository and tagged with the version you specified. You'll receive an email from npm notifying you that a new version of your package has been successfully published!