Skip to content

Commit c53cbcd

Browse files
authored
Merge pull request #2186 from urfave/make-v3-recommended
Document that `v3` series is recommended for new development
2 parents 8a4b044 + 357bd32 commit c53cbcd

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

docs/index.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ Go Modules are required when using this package. [See the go blog guide on using
4646

4747
### Using `v3` releases
4848

49-
The latest `v3` release may be installed via the `/v3` suffix. The state of the [`main`
50-
branch](https://github.com/urfave/cli/tree/main) at any given time may correspond to a
51-
`v3` series release or pre-release. Please see the [`v3` migration
52-
guide](./migrate-v2-to-v3.md) on using v3 if you are upgrading from v2.
49+
The latest `v3` release may be installed via the `/v3` suffix and is the
50+
recommended version for all new development. The state of the [`main`
51+
branch](https://github.com/urfave/cli/tree/main) at any given time **may**
52+
correspond to a `v3` series release or pre-release. Please see the [`v3`
53+
migration guide](./migrate-v2-to-v3.md) on using v3 if you are upgrading from
54+
v2.
5355

5456
```sh
5557
go get github.com/urfave/cli/v3@latest
@@ -63,10 +65,11 @@ import (
6365

6466
### Using `v2` releases
6567

66-
The `v2` series is the recommended version for new development. Ongoing
67-
maintenance is done on the [`v2-maint`
68-
branch](https://github.com/urfave/cli/tree/v2-maint) which receives **minor**
69-
improvements, bug fixes, and security fixes.
68+
:warning: The `v2` series is receiving **security and bug fixes only** via the
69+
[`v2-maint` branch](https://github.com/urfave/cli/tree/v2-maint) and **should
70+
not** be used in new development. Please see the [`v3` migration
71+
guide](./migrate-v2-to-v3.md) and feel free to open an issue or discussion if
72+
you need help with the migration to `v3`.
7073

7174
```sh
7275
go get github.com/urfave/cli/v2@latest
@@ -81,7 +84,7 @@ import (
8184
### Using `v1` releases
8285

8386
:warning: The `v1` series is receiving **security fixes only** via the
84-
[`v1-maint`](https://github.com/urfave/cli/tree/v1-maint) branch and **should
87+
[`v1-maint` branch](https://github.com/urfave/cli/tree/v1-maint) and **should
8588
not** be used in new development. Please see the [`v2` migration
8689
guide](./migrate-v1-to-v2.md) and feel free to open an issue or discussion if
8790
you need help with the migration to `v2`.

0 commit comments

Comments
 (0)