From d89c5c52e7ffa34f989b2b825febc675f7774642 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 25 Jul 2025 11:01:33 -0400 Subject: [PATCH 1/6] update github and reviewers schema sections --- .../reference/generators-yml-reference.mdx | 57 ++++++++++++------- 1 file changed, 37 insertions(+), 20 deletions(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index a345e078..823631b4 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -674,28 +674,48 @@ groups: ### GitHub Configuration - - +There are three ways (`mode`) to deploy your SDK code to GitHub: +* **Commit and release** (recommended) - Fern generates your code, commits it to main, and tags a new release. +* **Pull request** - Fern generates your code, commits to a new branch, and opens a PR for review. To publish, you must merge the PR and tag a GitHub release. +* **Push** - Fern generates your code and pushes it to the branch you specify. - - +For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can optionally +specify a branch name, license, and reviewers. - - +```yml {6-17} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "commit" + branch: "your-branch-name" + license: "MIT" + reviewers: + teams: + - name: "sdk-team" + - name: "api-team" + users: + - name: "john-doe" + - name: "jane-smith" +``` - + - + - + - + - + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). ### Generator Metadata @@ -741,17 +761,14 @@ reviewers: - name: "jane-smith" ``` - - - - - - - + + GitHub team names that should review generated code. - + + GitHub users that should review generated code. - + +Name of a GitHub team or a user. \ No newline at end of file From b49c542156bcd7e944e76d7bb9157e32c9582e3d Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 25 Jul 2025 11:06:24 -0400 Subject: [PATCH 2/6] update branch description --- fern/products/sdks/reference/generators-yml-reference.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 823631b4..1285d7ac 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -680,7 +680,7 @@ There are three ways (`mode`) to deploy your SDK code to GitHub: * **Push** - Fern generates your code and pushes it to the branch you specify. For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can optionally -specify a branch name, license, and reviewers. +specify a branch name (required for `mode: push`), license, and reviewers. ```yml {6-17} groups: @@ -709,6 +709,7 @@ groups: +Required for `mode: push`. From d57cc8ae705f7a60652cf72b60023e71623ec0b8 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 25 Jul 2025 17:56:52 -0400 Subject: [PATCH 3/6] restructuring --- .../reference/generators-yml-reference.mdx | 105 +++++++++++++++--- 1 file changed, 87 insertions(+), 18 deletions(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 1285d7ac..adc25625 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -674,15 +674,20 @@ groups: ### GitHub Configuration -There are three ways (`mode`) to deploy your SDK code to GitHub: -* **Commit and release** (recommended) - Fern generates your code, commits it to main, and tags a new release. -* **Pull request** - Fern generates your code, commits to a new branch, and opens a PR for review. To publish, you must merge the PR and tag a GitHub release. -* **Push** - Fern generates your code and pushes it to the branch you specify. +Specify how your SDKs are generated in GitHub using the `github` configuration. -For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can optionally -specify a branch name (required for `mode: push`), license, and reviewers. +Make sure the [Fern GitHub app](https://github.com/apps/fern-api) is installed on your destination repository -```yml {6-17} +For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can also +configure a branch name, license, and reviewers. + + +#### Commit and release (recommended) + +Fern generates your code, commits it to main, and tags a new release. + +Commit: +```yml {6-8} groups: ts-sdk: generators: @@ -691,25 +696,89 @@ groups: github: repository: "your-org/your-repo-name" mode: "commit" - branch: "your-branch-name" - license: "MIT" - reviewers: - teams: - - name: "sdk-team" - - name: "api-team" - users: - - name: "john-doe" - - name: "jane-smith" +``` + +Release: +```yml {6-17} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "release" +``` + + + + + + + + + + + + + + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). + + +#### Pull request + +Fern generates your code, commits to a new branch, and opens a PR for review. To publish, you must merge the PR and tag a GitHub release. + +```yml {6-8} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "pull-request" ``` - + -Required for `mode: push`. + + + + + + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). + + +#### Push + +Fern generates your code and pushes it to the branch you specify. + +```yml {6-8} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "push" + branch: "your-branch-name" # required for `mode: push` +``` + + + + + + + From 1cd951f114ccd56cb6d5158f0247d61501a01b5a Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 25 Jul 2025 17:58:47 -0400 Subject: [PATCH 4/6] edit --- .../reference/generators-yml-reference.mdx | 170 ------------------ 1 file changed, 170 deletions(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index adc25625..822a899b 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -672,173 +672,3 @@ groups: -### GitHub Configuration - -Specify how your SDKs are generated in GitHub using the `github` configuration. - -Make sure the [Fern GitHub app](https://github.com/apps/fern-api) is installed on your destination repository - -For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can also -configure a branch name, license, and reviewers. - - -#### Commit and release (recommended) - -Fern generates your code, commits it to main, and tags a new release. - -Commit: -```yml {6-8} -groups: - ts-sdk: - generators: - - name: fernapi/fern-typescript-sdk - ... - github: - repository: "your-org/your-repo-name" - mode: "commit" -``` - -Release: -```yml {6-17} -groups: - ts-sdk: - generators: - - name: fernapi/fern-typescript-sdk - ... - github: - repository: "your-org/your-repo-name" - mode: "release" -``` - - - - - - - - - - - - - - -Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). - - -#### Pull request - -Fern generates your code, commits to a new branch, and opens a PR for review. To publish, you must merge the PR and tag a GitHub release. - -```yml {6-8} -groups: - ts-sdk: - generators: - - name: fernapi/fern-typescript-sdk - ... - github: - repository: "your-org/your-repo-name" - mode: "pull-request" -``` - - - - - - - - - - - - - - -Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). - - -#### Push - -Fern generates your code and pushes it to the branch you specify. - -```yml {6-8} -groups: - ts-sdk: - generators: - - name: fernapi/fern-typescript-sdk - ... - github: - repository: "your-org/your-repo-name" - mode: "push" - branch: "your-branch-name" # required for `mode: push` -``` - - - - - - - - - - - - - -Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). - - -### Generator Metadata - - - - - - - - - - - - - - - - -### Snippets Configuration - - - - -### API Settings Override - - - - - - - -## reviewers -Who should review generated code. - -```yaml -reviewers: - teams: - - name: "sdk-team" - - name: "api-team" - users: - - name: "john-doe" - - name: "jane-smith" -``` - - - GitHub team names that should review generated code. - - - - GitHub users that should review generated code. - - - -Name of a GitHub team or a user. - \ No newline at end of file From 616c2764373d2ad17124cd5982ec0f3f272b5b64 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 25 Jul 2025 17:59:20 -0400 Subject: [PATCH 5/6] edit --- .../reference/generators-yml-reference.mdx | 170 ++++++++++++++++++ 1 file changed, 170 insertions(+) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 822a899b..adc25625 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -672,3 +672,173 @@ groups: +### GitHub Configuration + +Specify how your SDKs are generated in GitHub using the `github` configuration. + +Make sure the [Fern GitHub app](https://github.com/apps/fern-api) is installed on your destination repository + +For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can also +configure a branch name, license, and reviewers. + + +#### Commit and release (recommended) + +Fern generates your code, commits it to main, and tags a new release. + +Commit: +```yml {6-8} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "commit" +``` + +Release: +```yml {6-17} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "release" +``` + + + + + + + + + + + + + + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). + + +#### Pull request + +Fern generates your code, commits to a new branch, and opens a PR for review. To publish, you must merge the PR and tag a GitHub release. + +```yml {6-8} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "pull-request" +``` + + + + + + + + + + + + + + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). + + +#### Push + +Fern generates your code and pushes it to the branch you specify. + +```yml {6-8} +groups: + ts-sdk: + generators: + - name: fernapi/fern-typescript-sdk + ... + github: + repository: "your-org/your-repo-name" + mode: "push" + branch: "your-branch-name" # required for `mode: push` +``` + + + + + + + + + + + + + +Specify which teams and users should review generated code. See [reviewers configuration](#reviewers-1). + + +### Generator Metadata + + + + + + + + + + + + + + + + +### Snippets Configuration + + + + +### API Settings Override + + + + + + + +## reviewers +Who should review generated code. + +```yaml +reviewers: + teams: + - name: "sdk-team" + - name: "api-team" + users: + - name: "john-doe" + - name: "jane-smith" +``` + + + GitHub team names that should review generated code. + + + + GitHub users that should review generated code. + + + +Name of a GitHub team or a user. + \ No newline at end of file From 490b37fda7d110916c75de7e9fed86b2b24e29ed Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 29 Jul 2025 10:05:28 -0400 Subject: [PATCH 6/6] remove commit option --- .../reference/generators-yml-reference.mdx | 25 +++++-------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index adc25625..4702d36b 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -674,31 +674,18 @@ groups: ### GitHub Configuration -Specify how your SDKs are generated in GitHub using the `github` configuration. +Specify how your SDKs are generated in GitHub using the `github` configuration. +Designate the `mode` to specifiy how Fern handles your code changes. For all of the +modes, you must specify the GitHub repository in which you want to store your +SDK code. You can also configure a branch name, license, and reviewers. Make sure the [Fern GitHub app](https://github.com/apps/fern-api) is installed on your destination repository -For all of these modes, you must specify the GitHub repository in which you want to store your SDK code. You can also -configure a branch name, license, and reviewers. - -#### Commit and release (recommended) +#### Release (recommended) Fern generates your code, commits it to main, and tags a new release. -Commit: -```yml {6-8} -groups: - ts-sdk: - generators: - - name: fernapi/fern-typescript-sdk - ... - github: - repository: "your-org/your-repo-name" - mode: "commit" -``` - -Release: ```yml {6-17} groups: ts-sdk: @@ -713,7 +700,7 @@ groups: - +