docs(sdks): describe branch support in release mode#5115
Open
Swimburger wants to merge 1 commit intomainfrom
Open
docs(sdks): describe branch support in release mode#5115Swimburger wants to merge 1 commit intomainfrom
branch support in release mode#5115Swimburger wants to merge 1 commit intomainfrom
Conversation
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>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1776915448-release-branch-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
devalog
approved these changes
Apr 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
branchParamField undergithubrelease mode ingenerators-yml-reference.mdxpreviously had no description. This PR fills it in to explain the new behavior (the field is being wired up across fiddle + fern — see https://github.com/fern-api/fiddle/pull/713 and fern-api/fern#15298):fern/products/sdks/reference/generators-yml-reference.mdx: describe thatbranchunder release mode retargets commits and the release tag to the specified branch, and note the versioned-SDK use case.fern/products/sdks/snippets/github-publishing-mode.mdx: mention the optionalbranchoverride in the release-mode bullet.Review & Testing Checklist for Human
branchParamField now has a description).Notes
This PR documents behavior that will be functional once fiddle PR https://github.com/fern-api/fiddle/pull/713 is merged, tagged, and the follow-up fern PR bumps
@fern-fern/fiddle-sdkto wirebranchthrough. Schema acceptance ofbranchundermode: releaseis already landing via fern-api/fern#15298, so users running a fern CLI built from that PR can set the field without a validation error even before fiddle is deployed.Link to Devin session: https://app.devin.ai/sessions/11840acb772748b294bc5001ab3f7d81
Requested by: @Swimburger