mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
Update changelog readme to add rules on how to add changelog items
Signed-off-by: Benjamin Wang <wachao@vmware.com>
This commit is contained in:
parent
a5fb57b485
commit
e913a55f11
@ -1,4 +1,6 @@
|
|||||||
# Production recommendation
|
# Change logs
|
||||||
|
|
||||||
|
## Production recommendation
|
||||||
|
|
||||||
The minimum recommended etcd versions to run in **production** are v3.4.8+ and v3.5.4+. Refer to the [versioning policy](https://etcd.io/docs/v3.5/op-guide/versioning/) for more details.
|
The minimum recommended etcd versions to run in **production** are v3.4.8+ and v3.5.4+. Refer to the [versioning policy](https://etcd.io/docs/v3.5/op-guide/versioning/) for more details.
|
||||||
|
|
||||||
@ -9,3 +11,11 @@ If etcd process is killed, occasionally some committed transactions are not refl
|
|||||||
Recommendation is to upgrade to v3.5.4+.
|
Recommendation is to upgrade to v3.5.4+.
|
||||||
|
|
||||||
If you have encountered data corruption, please follow instructions on https://etcd.io/docs/v3.5/op-guide/data_corruption/.
|
If you have encountered data corruption, please follow instructions on https://etcd.io/docs/v3.5/op-guide/data_corruption/.
|
||||||
|
|
||||||
|
## Change log rules
|
||||||
|
1. Each patch release only includes changes against previous patch release.
|
||||||
|
For example, the change log of v3.5.5 should only include items which are new to v3.5.4.
|
||||||
|
2. For the first release (e.g. 3.4.0, 3.5.0, 3.6.0, 4.0.0 etc.) for each minor or major
|
||||||
|
version, it only includes changes which are new to the first release of previous minor
|
||||||
|
or major version. For example, v3.5.0 should only include items which are new to v3.4.0,
|
||||||
|
and v3.6.0 should only include items which are new to v3.5.0.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user