Update CHANGELOG with 3.10.2 entries #1187
Conversation
| Add a section for the new patch release containing the same entries as in the release, e.g. following a `1.2.3` release: | ||
|
|
||
| ```md | ||
| ## 1.3.0 [Unreleased] |
There was a problem hiding this comment.
| ## 1.3.0 [Unreleased] | |
| ## 1.2.4 [Unreleased] |
There was a problem hiding this comment.
1.3.0 is correct because this code block corresponds to the CHANGELOG.md on master, not the release branch (as in earlier instructions above).
Do we expect / want to maintain patch release notes on master prior to patch releases? IIRC we avoid doing so to avoid potential cherry-pick conflicts with the release branch.
There was a problem hiding this comment.
On further thought, I believe the expectation is yes (with caveats) given the "Important" note added in #1161 concerning shifting of entries from an unreleased patch section -> next unreleased minor section.
Revised the instructions accordingly.
There was a problem hiding this comment.
I believe the expectation is yes
I think so too. The CHANGELOG.md on master included ## 3.10.2 [Unreleased] (which this PR updates).
| Add a section for the new patch release containing the same entries as in the release, e.g. following a `1.2.3` release: | ||
|
|
||
| ```md | ||
| ## 1.3.0 [Unreleased] |
There was a problem hiding this comment.
I believe the expectation is yes
I think so too. The CHANGELOG.md on master included ## 3.10.2 [Unreleased] (which this PR updates).
Followup to #1160 which forgot to include CHANGELOG entries in the post-release changes PR due to release instructions only committing the patch entries to the release branch. Instructions are also updated accordingly.