diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index a345e0789..4702d36b3 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -674,28 +674,105 @@ groups: ### 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 + + +#### Release (recommended) + +Fern generates your code, commits it to main, and tags a new 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 @@ -741,17 +818,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