changelog: Refactor changelog and add changes for v3.5.8 #15586
Conversation
serathius
force-pushed
the
changelog-v3.5.8
branch
2 times, most recently
from
82644cf to
61b53b8
Compare
| ### Package `netutil` | ||
| - Upgrade [go to 1.19.7](https://github.com/etcd-io/etcd/pull/15429) | ||
| - Upgrade [golang.org/x/net to v0.7.0](https://github.com/etcd-io/etcd/pull/15337) | ||
| - Bump bbolt to [v1.3.7](https://github.com/etcd-io/etcd/pull/15222). | ||
| - Fix [consistently format IPv6 addresses for comparison](https://github.com/etcd-io/etcd/pull/15187) |
There was a problem hiding this comment.
Note #15187 fixed pkg/netutil, and it may be used by etcdserver and client (e.g. etcdutl), so it isn't accurate to get it listed under etcdserver.
There was a problem hiding this comment.
But, it's not. Only server imports it.
There was a problem hiding this comment.
etcdutl also depends on it via a long path,
(*v3Manager) Restore -> srv.VerifyBootstrap() (line 277 in etcdtul/snapshot/v3_snapshot.go) -> ...... -> resolveURL (line 91 in pkg/netutil/netutil.go)
There was a problem hiding this comment.
Being precise doesn't mean more understandable. For normal etcd user reading changlong information about netutil fixes is too obscure. Leaving for now, but we should consider renaming this section.
|
If you really want to refactor the the changelog, I would suggest to follow K8s, for example: Changelog since v1.26.2.
|
serathius
force-pushed
the
changelog-v3.5.8
branch
from
61b53b8 to
3f4115e
Compare
|
My goal was to make changelog consistent. All previous patch releases used sections grouping based on artifact ( |
serathius
force-pushed
the
changelog-v3.5.8
branch
from
3f4115e to
630ddee
Compare
serathius
force-pushed
the
changelog-v3.5.8
branch
from
630ddee to
42687f7
Compare
CHANGELOG/CHANGELOG-3.4.md
Outdated
|
|
||
| ### Package `clientv3` | ||
| - Reverted the fix to [auth invalid token and old revision errors in watch](https://github.com/etcd-io/etcd/pull/15542). | ||
|
|
||
| ### Go | ||
| - Require [Go 1.19+](https://github.com/etcd-io/etcd/pull/15337). |
There was a problem hiding this comment.
Noticed one thing. Isn't changing required minimal Go version in package a breaking change? We are basically forcing all users of clientv3 to upgrade Go in their applications even though we didn't do needed to.
I think that upgrading Go version used to compile etcdserver and required minimal Go version should be independent. We should also avoid changing the second one if not needed.
There was a problem hiding this comment.
It's recommended to use golang 1.19+ to build applications depending on clientv3, but it isn't a must. So suggest to change it to something like "Recommend Go 1.19+"
There was a problem hiding this comment.
Ok, https://go.dev/ref/mod#go-mod-file-go says If an older Go version builds one of the module’s packages and encounters a compile error, the error notes that the module was written for a newer Go version.. Confirming it is more of a recommendation.
CHANGELOG/CHANGELOG-3.4.md
Outdated
|
|
||
| ### Package `clientv3` | ||
| - Reverted the fix to [auth invalid token and old revision errors in watch](https://github.com/etcd-io/etcd/pull/15542). | ||
|
|
||
| ### Go | ||
| - Require [Go 1.19+](https://github.com/etcd-io/etcd/pull/15337). |
There was a problem hiding this comment.
It's recommended to use golang 1.19+ to build applications depending on clientv3, but it isn't a must. So suggest to change it to something like "Recommend Go 1.19+"
serathius
force-pushed
the
changelog-v3.5.8
branch
3 times, most recently
from
afa31d8 to
cb754db
Compare
Signed-off-by: Marek Siarkowicz <[email protected]>
serathius
force-pushed
the
changelog-v3.5.8
branch
from
cb754db to
34bb7ed
Compare
cc @ahrtr @ptabor