Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some clarity around available versions and level of support #1744

Merged
merged 3 commits into from
May 31, 2023
Merged

Add some clarity around available versions and level of support #1744

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffb36a4
Add some clarity around available versions and level of support
meatballhat May 29, 2023
f639456
Use plain `sh` code blocks for copy-pasta compat
meatballhat May 29, 2023
025f65b
Update docs/index.md
meatballhat May 31, 2023
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
37 changes: 26 additions & 11 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
goal is to enable developers to write fast and distributable command line applications in
an expressive way.

These are the guides for each major supported version:
These are the guides for each major version:

- [`v2`](./v2/getting-started.md)
- [`v1`](./v1/getting-started.md)
Expand All @@ -28,32 +28,47 @@ Go Modules are required when using this package. [See the go blog guide on using

### Using `v2` releases

```
$ go get github.com/urfave/cli/v2
The `v2` series is the recommended version for new development. Ongoing
maintenance is done on the [`v2-maint`
branch](https://github.com/urfave/cli/tree/v2-maint) which receives **minor**
improvements, bug fixes, and security fixes.

```sh
go get github.com/urfave/cli/v2@latest
```

```go
...
import (
"github.com/urfave/cli/v2" // imports as package "cli"
)
...
```

### Using `v1` releases
### Using **alpha-level** `v3` releases

```
$ go get github.com/urfave/cli
The latest pre-release in progress on the [`main`
branch](https://github.com/urfave/cli/tree/main) is the `v3` series which should
be considered **alpha-level** with an unstable API. Occasional **alpha** tags
are pushed to allow for limited stability without pinning to an arbitrary
commit:

```sh
go get github.com/urfave/cli/v3@latest
```

```go
...
import (
"github.com/urfave/cli"
"github.com/urfave/cli/v3" // imports as package "cli"
)
...
```

### Using `v1` releases

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

### Build tags

You can use the following build tags:
Expand Down