Skip to content

Commit

Permalink
Merge pull request #14570 from ahrtr/changelog_rules
Browse files Browse the repository at this point in the history
Update changelog readme to add rules on how to add changelog items
  • Loading branch information
ahrtr authored Oct 14, 2022
2 parents a861bfe + e913a55 commit f97aac9
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CHANGELOG/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -9,3 +11,11 @@ If etcd process is killed, occasionally some committed transactions are not refl
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/.

## 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.

0 comments on commit f97aac9

Please sign in to comment.