Skip to content

Commit 6b5569c

Browse files
committed
update push mode description
1 parent aef8cf5 commit 6b5569c

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

fern/products/sdks/overview/typescript/publishing-to-npm.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Optionally set the mode to control how Fern handles SDK publishing:
190190

191191
- `mode: release` (default): Fern generates code, commits to main, and tags a release automatically
192192
- `mode: pull-request`: Fern generates code and creates a PR for you to review before release
193-
- `mode: push`: Fern generates code and pushes to a branch for you to review before release
193+
- `mode: push`: Fern generates code and pushes to a branch you specify for you to review before release
194194

195195
```yaml title="generators.yml" {14}
196196
groups:
@@ -206,7 +206,8 @@ groups:
206206
namespaceExport: YourClientName
207207
github:
208208
repository: your-org/your-repository
209-
mode: pull-request
209+
mode: push
210+
branch: your-branch-name # Required for mode: push
210211
```
211212
You can also configure other settings, like the reviewers or license. Refer to the [full `github` (`generators.yml`) reference](/sdks/reference/generators-yml#github) for more information.
212213

fern/products/sdks/snippets/release-sdk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ The rest of the release process depends on your chosen mode:
22

33
- **Release mode (default):** If you didn't specify a `mode` or set `mode: release`, no further action is required. Fern automatically tags the new release with your specified version number and initiates the npm publishing workflow in your SDK repository.
44

5-
- **Pull request or push mode:** If you set `mode: pull-request` or `mode: push`, Fern creates a pull request. Merge this PR and [tag a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to initiate the npm publishing workflow in your SDK repository.
5+
- **Pull request or push mode:** If you set `mode: pull-request` or `mode: push`, Fern creates a pull request or pushes to a branch respectively. Review and merge the PR (`pull-request`) or branch (`push`), then [tag a new release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) to initiate the npm publishing workflow in your SDK repository.
66

77
Once the workflow completes, you can view your new release by logging into npm and navigating to **Packages**.

0 commit comments

Comments
 (0)