Skip to content

Commit 490b37f

Browse files
committed
remove commit option
1 parent 616c276 commit 490b37f

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -674,31 +674,18 @@ groups:
674674

675675
### GitHub Configuration
676676

677-
Specify how your SDKs are generated in GitHub using the `github` configuration.
677+
Specify how your SDKs are generated in GitHub using the `github` configuration.
678+
Designate the `mode` to specifiy how Fern handles your code changes. For all of the
679+
modes, you must specify the GitHub repository in which you want to store your
680+
SDK code. You can also configure a branch name, license, and reviewers.
678681

679682
<Note>Make sure the [Fern GitHub app](https://github.com/apps/fern-api) is installed on your destination repository</Note>
680683

681-
For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can also
682-
configure a branch name, license, and reviewers.
683684

684-
685-
#### Commit and release (recommended)
685+
#### Release (recommended)
686686

687687
Fern generates your code, commits it to main, and tags a new release.
688688

689-
Commit:
690-
```yml {6-8}
691-
groups:
692-
ts-sdk:
693-
generators:
694-
- name: fernapi/fern-typescript-sdk
695-
...
696-
github:
697-
repository: "your-org/your-repo-name"
698-
mode: "commit"
699-
```
700-
701-
Release:
702689
```yml {6-17}
703690
groups:
704691
ts-sdk:
@@ -713,7 +700,7 @@ groups:
713700
<ParamField path="repository" type="string" required={true} toc={true}>
714701
</ParamField>
715702

716-
<ParamField path="mode" type="'commit' | 'release''" required={false} toc={true}>
703+
<ParamField path="mode" type="'release'" required={false} toc={true}>
717704
</ParamField>
718705

719706
<ParamField path="branch" type="string" required={false} toc={true}>

0 commit comments

Comments
 (0)