You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
CHANGELOG.md shouldn't include pre-release changes? #31491
I was looking for v8.1.0 changelog, and realized that I need to read all pre-release versions in order to know what's changed. See the changes on changelog.md:
Reading the other releases, there was many, many other changes on this release that are not on changelog of the version itself, but on .rc*, .next-*...
Shouldn't the changelog be a merge of all pre-release versions?
Reacted by victoriaguyton2014, Michael Prentice and Derek Parsons
@iget-master You're correct, in general the changelog should be a merge of pre-release versions. But in the case of .next-*, any of these changes that are currently landing are targeting the next minor release, which would be 8.2.0 and therefore won't be in the 8.1.x changelog. With the .rc-* version, it depends on what was in RC. So if it was 8.1.0-rc.x, those changes should be in the changelog for 8.1.x.
If you could call out specific items in the changelog that you feel are missing, that would be great. It's possible we miss some when running our release scripts.
Also, for the most part, reading the changelog at master should give you a combination of all changes from all versions. The only exception here is when there's a change to an earlier version that for some reason doesn't need to be applied to the most recent version. An example could be a fix to code in something like 8.1.x that doesn't need to be fixed on master because the behavior has already been refactored or changed in master and that change wasn't applied to the stable version. This is very rare though.
Since opening this issue the changelog is now being updated to combine all changes since next/rc releases when the final release is made, so I'm closing this as addressed.
Activity
[-]CHANGELOG shouldn't include pre-release changes?[/-][+]CHANGELOG.md shouldn't include pre-release changes?[/+]jasonaden commentedon Jul 10, 2019
@iget-master You're correct, in general the changelog should be a merge of pre-release versions. But in the case of
.next-*, any of these changes that are currently landing are targeting the next minor release, which would be8.2.0and therefore won't be in the8.1.xchangelog. With the.rc-*version, it depends on what was in RC. So if it was8.1.0-rc.x, those changes should be in the changelog for8.1.x.If you could call out specific items in the changelog that you feel are missing, that would be great. It's possible we miss some when running our release scripts.
jasonaden commentedon Jul 10, 2019
Also, for the most part, reading the changelog at
mastershould give you a combination of all changes from all versions. The only exception here is when there's a change to an earlier version that for some reason doesn't need to be applied to the most recent version. An example could be a fix to code in something like8.1.xthat doesn't need to be fixed onmasterbecause the behavior has already been refactored or changed inmasterand that change wasn't applied to the stable version. This is very rare though.iget-master commentedon Jul 10, 2019
Let me give you a sample:
On changelog for
8.1.0, excluding.next-*, we have:Note that the
8.1.0final release changelog is not a merge ofbeta.0+rc.0+8.1.0rockument69 commentedon May 27, 2020
@kapunahelewong : I don't think this is a docs issue. This doc seems to be generated, not edited by us:
CHANGELOG.md
JoostK commentedon May 24, 2021
Since opening this issue the changelog is now being updated to combine all changes since
next/rcreleases when the final release is made, so I'm closing this as addressed.angular-automatic-lock-bot commentedon Jun 24, 2021
This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.
Read more about our automatic conversation locking policy.
This action has been performed automatically by a bot.