Skip to content

Commit b9b06fb

Browse files
committed
Add --deep flag to TypeScript SDK generation commands
Update documentation and examples to include the --deep flag when generating TypeScript SDKs. The --deep flag enables deep generation mode which is recommended for TypeScript SDK generation and other generators that benefit from enhanced processing. Changes: - Updated CLI reference to document the --deep flag - Modified all TypeScript SDK generation examples to use --deep flag - Updated GitHub Actions and GitLab CI/CD examples - Improved code example formatting for consistency
1 parent bcc80ad commit b9b06fb

File tree

7 files changed

+23
-15
lines changed

7 files changed

+23
-15
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/cli-api-reference/pages/cli-get-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ fern generate --docs # Generate and publish documentation
7171
fern init # Start new SDK project
7272
fern check # Validate API definition
7373
fern generate --preview # Preview SDKs in .preview/ folder
74-
fern generate # Generate default SDK group
75-
fern generate --group ts-sdk # Generate specific SDK group
74+
fern generate # Generate default SDK group
75+
fern generate --deep --group ts-sdk # Generate TypeScript SDK
7676
```
7777

7878
<Note>

fern/products/cli-api-reference/pages/commands.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,21 +174,29 @@ hideOnThisPage: true
174174

175175
<CodeBlock title="terminal">
176176
```bash
177-
fern generate [--group <group>] [--api <api>] [--version <version>] [--preview]
177+
fern generate [--deep] [--group <group>] [--api <api>] [--version <version>] [--preview]
178178
```
179179
</CodeBlock>
180180

181+
### deep
182+
183+
Use `--deep` to enable deep generation mode. This flag is recommended for TypeScript SDK generation and other generators that benefit from enhanced processing.
184+
185+
```bash
186+
fern generate --deep --group ts-sdk
187+
```
188+
181189
### preview
182190

183191
Use `--preview` to test SDK changes locally before publishing. This is especially useful during development:
184192
- Generates SDK into a local `.preview/` folder
185193
- Allows quick iteration on your Fern definition
186194
- No changes are published to package managers or GitHub
187-
195+
188196
```bash
189197
# Preview all SDKs
190198
fern generate --preview
191-
199+
192200
# Preview specific SDK group
193201
fern generate --group python-sdk --preview
194202
```

fern/products/cli-api-reference/pages/global-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,5 @@ Use the `--version` option to specify the SDK version number, typically followin
9797
fern generate --api payments-api --group python-sdk --version 1.2.3
9898

9999
# Generate TypeScript SDK for the auth API with version 0.1.0
100-
fern generate --api auth --group ts-sdk --version 0.1.0
100+
fern generate --deep --api auth --group ts-sdk --version 0.1.0
101101
```

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,15 +42,15 @@ 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
53-
```
52+
fern generate --deep --api your-api-name --group ts-sdk
53+
```
5454
</Note>
5555

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

0 commit comments

Comments
 (0)