From 4bc3f7449a867939b14aa9c558d8b2700f071250 Mon Sep 17 00:00:00 2001
From: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>
Date: Thu, 23 Apr 2026 03:37:46 +0000
Subject: [PATCH] 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>
---
fern/products/sdks/reference/generators-yml-reference.mdx | 2 +-
fern/products/sdks/snippets/github-publishing-mode.mdx | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx
index fc9bf78ad..d6e06d618 100644
--- a/fern/products/sdks/reference/generators-yml-reference.mdx
+++ b/fern/products/sdks/reference/generators-yml-reference.mdx
@@ -851,7 +851,7 @@ Name of your repository in GitHub.
-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.
diff --git a/fern/products/sdks/snippets/github-publishing-mode.mdx b/fern/products/sdks/snippets/github-publishing-mode.mdx
index 1ec75f87b..0951f9465 100644
--- a/fern/products/sdks/snippets/github-publishing-mode.mdx
+++ b/fern/products/sdks/snippets/github-publishing-mode.mdx
@@ -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