Skip to content

docs: add migration tool info #3708

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 2 commits into from
Aug 24, 2025
Merged

docs: add migration tool info #3708

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f35e3a1
docs: add migration tool info
ReneWerner87 Aug 24, 2025
a750573
docs: fix markdown heading
ReneWerner87 Aug 24, 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
26 changes: 26 additions & 0 deletions docs/whats_new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@

In this guide, we'll walk you through the most important changes in Fiber `v3` and show you how to migrate your existing Fiber `v2` applications to Fiber `v3`.

### 🛠️ Migration tool

Fiber v3 introduces a CLI-powered migration helper. Install the CLI and let
it update your project automatically:

```bash
go install github.com/gofiber/cli/fiber@latest
fiber migrate --to 3.0.0
```

See the [migration guide](#-migration-guide) for more details and options.

Here's a quick overview of the changes in Fiber `v3`:

- [🚀 App](#-app)
Expand Down Expand Up @@ -1403,6 +1415,20 @@

## 📋 Migration guide

To streamline upgrades between Fiber versions, the Fiber CLI ships with a
`migrate` command:

```bash
go install github.com/gofiber/cli/fiber@latest
fiber migrate --to 3.0.0
```

**Options**

Check failure on line 1426 in docs/whats_new.md

View workflow job for this annotation

GitHub Actions / markdownlint

Emphasis used instead of a heading 

docs/whats_new.md:1426 MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "Options"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md

- `-t, --to string` migrate to a specific version, e.g. `3.0.0`
- `-f, --force` force migration even if already on that version
- `-s, --skip_go_mod` skip running `go mod tidy`, `go mod download`, and `go mod vendor`
Comment on lines +1428 to +1430
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Aug 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability, consider rephrasing the descriptions for the CLI options to be more concise and consistently formatted. This will help users quickly understand the purpose of each flag.

Suggested change
- `-t, --to string` migrate to a specific version, e.g. `3.0.0`
- `-f, --force` force migration even if already on that version
- `-s, --skip_go_mod` skip running `go mod tidy`, `go mod download`, and `go mod vendor`
- `-t, --to string` Target version for migration (e.g., `3.0.0`).
- `-f, --force` Force migration, even if the project is already on the target version.
- `-s, --skip_go_mod` Skip running `go mod` commands (`tidy`, `download`, `vendor`).


- [🚀 App](#-app-1)
- [🎣 Hooks](#-hooks-1)
- [🚀 Listen](#-listen-1)
Expand Down
Loading