Skip to content

Commit 8f32f0f

Browse files
authored
Update README (#172)
Update minimum version notes and clarify the maintenance (and lack thereof) of this repository.
1 parent c74507b commit 8f32f0f

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77
Golines is a Go code formatter that shortens long lines, in addition to all
88
of the formatting fixes done by [`gofmt`](https://golang.org/cmd/gofmt/).
99

10+
## Maintenance
11+
12+
As of late 2024, [segmentio/golines](https://github.com/segmentio/golines/) has
13+
functionally been in maintenance mode and several dependencies appear to be
14+
similarly unmaintained. At some point in Q4 2025, this repository
15+
[will be archived](https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories)
16+
unless active maintainership can be found within Twilio Segment.
17+
The code will remain available and the terms of the license will not be changed.
18+
1019
## Motivation
1120

1221
The standard Go formatting tools (`gofmt`, `goimports`, etc.) are great, but
@@ -46,11 +55,15 @@ view of a file with very long lines. More example pairs can be found in the
4655

4756
## Version support
4857

49-
Newer releases of `golines` require at least Go 1.18 due to generics-related dependencies.
50-
However, the [minimum version](https://go.dev/ref/mod#go-mod-file-go) in [`go.mod`](./go.mod)
51-
should be considered the minimum required version of Go for any given version
52-
of `golines.` If you need to use `golines` with an older version of go, install
53-
the tool from the `v0.9.0` release.
58+
Since v0.10.0, releases of `golines` have required at least Go 1.18 due to
59+
generics-related dependencies. As of v0.13.0, `golines` requires a minimum of
60+
Go 1.23 due to transitive requirements introduced by dependencies.
61+
62+
Generally, the [minimum version](https://go.dev/ref/mod#go-mod-file-go) in [`go.mod`](./go.mod)
63+
is the absolute minimum required version of Go for any given version of `golines.`
64+
65+
If you need to use `golines` with an older version of go, install the tool from
66+
the `v0.9.x` or `v0.12.x` releases.
5467

5568
## Usage
5669

0 commit comments

Comments
 (0)