Skip to content

Commit eac452b

Browse files
authored
Merge pull request #2155 from urfave/un-alpha
Remove "alpha" wording around `v3` series
2 parents fa4fd12 + bb4db66 commit eac452b

File tree

2 files changed

+20
-21
lines changed

2 files changed

+20
-21
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,21 @@ milestones and import paths to which they correspond are:
2020

2121
<https://github.com/urfave/cli/tree/main>
2222

23-
The majority of active development and issue management is targeting the `main` branch,
24-
which is currently in *alpha*.
23+
The majority of active development and issue management is targeting the `main` branch.
2524

2625
- :arrow_right: [`v3.x`](https://github.com/urfave/cli/milestone/5)
2726
- :arrow_right: `github.com/urfave/cli/v3`
2827

2928
The `main` branch includes tooling to help with keeping track of `v3.x` series backward
3029
compatibility. More details on this process are in the development workflow section below.
3130

32-
#### `v1` branch
31+
#### `v1-maint` branch
3332

34-
<https://github.com/urfave/cli/tree/v1>
33+
<https://github.com/urfave/cli/tree/v1-maint>
3534

36-
The `v1` branch is no longer maintained.
35+
The `v1-maint` branch **MUST** only receive bug fixes in the `v1.22.x` series. There is no
36+
strict rule regarding bug fixes to the `v3.x` or `v2.23.x` series being backported to the
37+
`v1.22.x` series.
3738

3839
- :arrow_right: [`v1.22.x`](https://github.com/urfave/cli/milestone/11)
3940
- :arrow_right: `github.com/urfave/cli`

docs/index.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,39 +44,37 @@ Using this package requires a working Go environment. [See the install instructi
4444

4545
Go Modules are required when using this package. [See the go blog guide on using Go Modules](https://blog.golang.org/using-go-modules).
4646

47-
### Using `v2` releases
47+
### Using `v3` releases
4848

49-
The `v2` series is the recommended version for new development. Ongoing
50-
maintenance is done on the [`v2-maint`
51-
branch](https://github.com/urfave/cli/tree/v2-maint) which receives **minor**
52-
improvements, bug fixes, and security fixes.
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.
5353

5454
```sh
55-
go get github.com/urfave/cli/v2@latest
55+
go get github.com/urfave/cli/v3@latest
5656
```
5757

5858
```go
5959
import (
60-
"github.com/urfave/cli/v2" // imports as package "cli"
60+
"github.com/urfave/cli/v3" // imports as package "cli"
6161
)
6262
```
6363

64-
### Using **alpha-level** `v3` releases
64+
### Using `v2` releases
6565

66-
The latest pre-release in progress on the [`main`
67-
branch](https://github.com/urfave/cli/tree/main) is the `v3` series which should
68-
be considered **alpha-level** with an unstable API. Occasional **alpha** tags
69-
are pushed to allow for limited stability without pinning to an arbitrary
70-
commit. Please see the [`v3` migration
71-
guide](./migrate-v2-to-v3.md) on using v3 if you are upgrading from v2
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.
7270

7371
```sh
74-
go get github.com/urfave/cli/v3@latest
72+
go get github.com/urfave/cli/v2@latest
7573
```
7674

7775
```go
7876
import (
79-
"github.com/urfave/cli/v3" // imports as package "cli"
77+
"github.com/urfave/cli/v2" // imports as package "cli"
8078
)
8179
```
8280

0 commit comments

Comments
 (0)