Skip to content

docs(sdks): describe branch support in release mode #5115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Swimburger wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

docs(sdks): describe branch support in release mode #5115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/products/sdks/reference/generators-yml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ Name of your repository in GitHub.
</ParamField>

<ParamField path="branch" type="string" required={false} toc={true}>
Name of your branch in GitHub.
If specified, Fern commits and tags the release on this branch instead of the default branch. The branch must already exist. Use this to publish versioned SDKs (e.g., `v1` and `v2`) from a single repo.
</ParamField>

<ParamField path="license" type="'MIT' | 'Apache-2.0' | 'Custom License Name'" required={false} toc={true}>
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/snippets/github-publishing-mode.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Optionally set the mode to control how Fern handles SDK publishing:

- `mode: release` (default): Fern generates code, commits to main, and tags a release automatically
- `mode: release` (default): Fern generates code, commits to the default branch (or the `branch` you specify), and tags a release automatically
- `mode: pull-request` (recommended): Fern generates code and creates a PR for you to review before release
- `mode: push`: Fern generates code and pushes to a branch you specify for you to review before release

Expand Down
Loading