Skip to content

docs: Update TypeScript SDK publishing guide and image references #403

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Update TypeScript SDK publishing guide and image references #403

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
30 changes: 15 additions & 15 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 @@ -3,12 +3,12 @@ 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/). After following the steps on this page,
you'll have a versioned package published on npm.
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.

Deep made a change!!!

<Frame>
<img src="assets/npm-packages.png" alt="Versioned package published on npm" />
<img src="file:3afaf258-4304-4245-8cef-fb9bd4909581" alt="Versioned package published on npm" />
</Frame>

<Info>
Expand All @@ -35,7 +35,7 @@ you'll have a versioned package published on npm.
ts-sdk: # Group name for your TypeScript SDK
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
version: 2.5.0
output:
location: npm

Expand All @@ -52,7 +52,7 @@ groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
version: 2.5.0
output:
location: npm
package-name: your-package-name
Expand All @@ -70,7 +70,7 @@ groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
version: 2.5.0
output:
location: npm
package-name: your-package-name
Expand All @@ -89,7 +89,7 @@ groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
version: 2.5.0
output:
location: npm
package-name: your-package-name
Expand Down Expand Up @@ -136,7 +136,7 @@ groups:
<Warning>Save your new token – it won’t be displayed after you leave the page.</Warning>

<Frame>
<img src="assets/npm-automation-token.png" alt="Creating NPM Automation Token" />
<img src="file:fb37cb53-1eb0-4486-ab6a-248135d769f4" alt="Creating NPM Automation Token" />
</Frame>

</Accordion>
Expand All @@ -152,7 +152,7 @@ groups:
<Warning>Save your new token – it won’t be displayed after you leave the page.</Warning>

<Frame>
<img src="assets/granular-access-token.png" alt="Creating Granular Access Token" />
<img src="file:8a9eb374-127c-4f03-926a-6b987150edec" alt="Creating Granular Access Token" />
</Frame>

</Accordion>
Expand All @@ -177,7 +177,7 @@ Set up a release workflow via [GitHub Actions](https://docs.github.com/en/action
Open your Fern repository in GitHub. Click on the **Settings** tab in your repository. Then, under the **Security** section, open **Secrets and variables** > **Actions**.

<Frame>
<img src="assets/github-secret.png" alt="Adding GitHub Repository Secret" />
<img src="file:18b8f1bc-85ca-4aa1-97ba-7b0dbe27bc88" alt="Adding GitHub Repository Secret" />
</Frame>

You can also use the url `https://github.com/<your-repo>/settings/secrets/actions`.
Expand All @@ -191,7 +191,7 @@ Set up a release workflow via [GitHub Actions](https://docs.github.com/en/action
1. Click **Add secret**.

<Frame>
<img src="assets/npm-token-secret.png" alt="NPM_TOKEN secret" />
<img src="file:33df8efe-2d45-4790-b612-7cdb57200877" alt="NPM_TOKEN secret" />
</Frame>

</Step>
Expand All @@ -205,7 +205,7 @@ Set up a release workflow via [GitHub Actions](https://docs.github.com/en/action
1. Click **Add secret**.

<Frame>
<img src="assets/npm-token-secret.png" alt="NPM_TOKEN secret" />
<img src="file:33df8efe-2d45-4790-b612-7cdb57200877" alt="NPM_TOKEN secret" />
</Frame>

</Step>
Expand Down Expand Up @@ -248,7 +248,7 @@ Set up a release workflow via [GitHub Actions](https://docs.github.com/en/action
click **Run workflow**.

<Frame>
<img src="assets/ts-sdk-release-action.png" alt="Running TS publish workflow" />
<img src="file:740c3de5-b652-47ef-b643-8026bfb3ced9" alt="Running TS publish workflow" />
</Frame>

Once your workflow completes, log back into npm and
Expand All @@ -269,7 +269,7 @@ groups:
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: <Markdown src="/snippets/typescript-sdk-version.mdx"/>
version: 2.5.0
output:
location: npm
package-name: name-of-your-package
Expand Down
Loading