Skip to content

Commit 4bc3f74

Browse files
docs(sdks): describe branch support in release mode
Expand the 'branch' ParamField under release-mode github config to explain that it retargets commits and tags to a non-default branch, and mention the new optional behavior in the publishing-mode snippet. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent fc9030f commit 4bc3f74

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,7 @@ Name of your repository in GitHub.
851851
</ParamField>
852852

853853
<ParamField path="branch" type="string" required={false} toc={true}>
854-
Name of your branch in GitHub.
854+
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.
855855
</ParamField>
856856

857857
<ParamField path="license" type="'MIT' | 'Apache-2.0' | 'Custom License Name'" required={false} toc={true}>

fern/products/sdks/snippets/github-publishing-mode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

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

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

0 commit comments

Comments
 (0)