Skip to content

Update TypeScript SDK documentation to include --deep flag #1487

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

Closed
wants to merge 1 commit into from
Closed

Update TypeScript SDK documentation to include --deep flag #1487

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion examples/sdks/typescript-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ jobs:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
fern generate --group ts-sdk --version ${{ inputs.version }} --log-level debug
fern generate --deep --group ts-sdk --version ${{ inputs.version }} --log-level debug
4 changes: 2 additions & 2 deletions fern/products/docs/pages/developer-tools/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ publish_sdks:
stage: publish_sdks
rules:
- if: '$CI_PIPELINE_SOURCE == "web"'
script:
script:
- echo "Publishing SDKs"
- fern generate --group ts-sdk --version $VERSION --log-level debug
- fern generate --deep --group ts-sdk --version $VERSION --log-level debug
```
</Accordion>

Expand Down
6 changes: 3 additions & 3 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 @@ -156,7 +156,7 @@ OIDC-based publishing (also known as "trusted publishing") is the most secure wa
Generate your SDK to create the GitHub Actions workflow with OIDC configuration:

```bash
fern generate --group ts-sdk
fern generate --deep --group ts-sdk
```

This creates a `.github/workflows/ci.yml` file that's configured to use OIDC for npmjs publishing. Alternatively, you can push your `generators.yml` changes and let the Fern GitHub Action generate the workflow for you.
Expand Down Expand Up @@ -296,7 +296,7 @@ jobs:
- name: Generate and publish SDK
env:
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
run: fern generate --group ts-sdk --version ${{ inputs.version }} --log-level debug
run: fern generate --deep --group ts-sdk --version ${{ inputs.version }} --log-level debug
```

Add your `FERN_TOKEN` as a repository secret (run `fern token` to generate one), then trigger the workflow from the **Actions** tab.
Expand Down Expand Up @@ -386,7 +386,7 @@ This is the easiest path if you can upgrade to version 3.12.0 or later of the Ty
**Locally:**

```bash
fern generate --group ts-sdk
fern generate --deep --group ts-sdk
```

**Or via GitHub Actions:**
Expand Down
6 changes: 3 additions & 3 deletions fern/products/sdks/overview/typescript/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`:
Run the following command to generate your SDK:

```bash
fern generate --group ts-sdk
fern generate --deep --group ts-sdk
```

<Note>
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:

```bash
fern generate --group ts-sdk --api your-api-name
fern generate --deep --group ts-sdk --api your-api-name
```
</Note>

<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>

```bash
fern/ # created by fern init
sdks/ # created by fern generate --group ts-sdk
sdks/ # created by fern generate --deep --group ts-sdk
├─ typescript
├─ Client.ts
├─ index.ts
Expand Down