Skip to content

Commit 46abab0

Browse files
fern-supportclaude
andcommitted
Update TypeScript SDK documentation to include --deep flag
Added the --deep flag to all fern generate commands for TypeScript SDK generation throughout the documentation. This flag is required for the latest CLI version to properly generate TypeScript SDKs. Updated files: - TypeScript quickstart guide - TypeScript npm publishing guide - GitLab CI/CD configuration - Example typescript-publish.yml workflow 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent c194e20 commit 46abab0

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

examples/sdks/typescript-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ jobs:
2929
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
3030
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
3131
run: |
32-
fern generate --group ts-sdk --version ${{ inputs.version }} --log-level debug
32+
fern generate --deep --group ts-sdk --version ${{ inputs.version }} --log-level debug

fern/products/docs/pages/developer-tools/gitlab.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ publish_sdks:
6767
stage: publish_sdks
6868
rules:
6969
- if: '$CI_PIPELINE_SOURCE == "web"'
70-
script:
70+
script:
7171
- echo "Publishing SDKs"
72-
- fern generate --group ts-sdk --version $VERSION --log-level debug
72+
- fern generate --deep --group ts-sdk --version $VERSION --log-level debug
7373
```
7474
</Accordion>
7575

fern/products/sdks/overview/typescript/publishing-to-npm.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ OIDC-based publishing (also known as "trusted publishing") is the most secure wa
156156
Generate your SDK to create the GitHub Actions workflow with OIDC configuration:
157157

158158
```bash
159-
fern generate --group ts-sdk
159+
fern generate --deep --group ts-sdk
160160
```
161161

162162
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.
@@ -296,7 +296,7 @@ jobs:
296296
- name: Generate and publish SDK
297297
env:
298298
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
299-
run: fern generate --group ts-sdk --version ${{ inputs.version }} --log-level debug
299+
run: fern generate --deep --group ts-sdk --version ${{ inputs.version }} --log-level debug
300300
```
301301

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

388388
```bash
389-
fern generate --group ts-sdk
389+
fern generate --deep --group ts-sdk
390390
```
391391

392392
**Or via GitHub Actions:**

fern/products/sdks/overview/typescript/quickstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@ This command adds the following `group` to `generators.yml`:
4242
Run the following command to generate your SDK:
4343
4444
```bash
45-
fern generate --group ts-sdk
45+
fern generate --deep --group ts-sdk
4646
```
4747

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

5151
```bash
52-
fern generate --group ts-sdk --api your-api-name
52+
fern generate --deep --group ts-sdk --api your-api-name
5353
```
5454
</Note>
5555

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

5858
```bash
5959
fern/ # created by fern init
60-
sdks/ # created by fern generate --group ts-sdk
60+
sdks/ # created by fern generate --deep --group ts-sdk
6161
├─ typescript
6262
├─ Client.ts
6363
├─ index.ts

0 commit comments

Comments
 (0)