Skip to content

(cli) Document --include-major option #855

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

Merged
merged 3 commits into from
Sep 17, 2025
Merged

(cli) Document --include-major option #855

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3d01b6
document --include-major option
devalog Sep 17, 2025
e1576df
nit
devalog Sep 17, 2025
c8dcc15
make it more concise
devalog Sep 17, 2025
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
17 changes: 13 additions & 4 deletions fern/products/cli-api-reference/pages/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,9 +498,13 @@ hideOnThisPage: true
<Accordion title="fern generator upgrade">
Use `fern generator upgrade` to update all generators in your `generators.yml` to their latest versions.

<Note>
This is different from `fern upgrade` which updates the Fern CLI version. Use both commands to keep your entire Fern toolchain up to date.
</Note>

<CodeBlock title="terminal">
```bash
fern generator upgrade [--list] [--generator <generator-name>] [--group <group>]
fern generator upgrade [--list] [--generator <generator-name>] [--group <group>] [--include-major]
```
</CodeBlock>

Expand Down Expand Up @@ -553,8 +557,13 @@ hideOnThisPage: true
fern generator upgrade --group public
```

<Note>
This is different from `fern upgrade` which updates the Fern CLI version. Use both commands to keep your entire Fern toolchain up to date.
</Note>
### include-major

```bash
fern generator upgrade --include-major
```

Use `--include-major` to include major version upgrades. Major versions are skipped by default to prevent breaking changes.

</Accordion>
</AccordionGroup>