meta: split CHANGELOG into two files#6337
Uh oh!
There was an error while loading. Please reload this page.
Conversation
claudiorodriguez added the meta 
claudiorodriguez commented Apr 21, 2016
LGTM, and +1 as dealing with huge changelogs can be painful when you just want to look at the recent changes. However, might be getting a bit ahead of myself here, but are we just going to keep on piling stuff onto the "archive" file, or are we going to go with something like |
silverwind commented Apr 21, 2016
May I suggest moving the archived file into |
MylesBorins commented Apr 21, 2016
@silverwind totally up for that... I want to wait to hear if anyone wants to follow a specific naming convention and I'll fix that up |
jasnell commented Apr 21, 2016
LGTM with moving archive doc into docs dir |
evanlucas commented Apr 22, 2016
Won't this break links in a lot of blog posts? |
MylesBorins commented Apr 22, 2016
We can alternatively take out everything from before v0.10 and that will give us a stopgap to decide what we want to do. @evanlucas at the very least it won't break any modern websites |
A project I used to work on had the last 1-1.5 years in CHANGELOG with everything before that split per year (CHANGELOG.2008, CHANGELOG.2009, etc.) I agree that they should be kept out of the top-level directory. Perhaps add a note at the bottom of the CHANGELOG that older entries can be found in doc/. EDIT: Should have read #5533. |
MylesBorinsforce-pushed the archive-changelog branch from 59d81e6 to 4abaf8eCompareMylesBorins commented Apr 22, 2016
I've updated the commit. Everything older than a year is now in I have added a link at the end of the changelog to the archive |
MylesBorinsforce-pushed the archive-changelog branch from 4abaf8e to 6fd28c4Comparejasnell commented Apr 22, 2016
@thealphanerd ... Just a thought: how difficult do you think it would be to at least keep the headers of the removed releases and include a link to the new location? If folks have links to the changelog for specific releases then doing so may alleviate some of the pain of broken links. |
evanlucas commented Apr 22, 2016
+1 to what @jasnell sqid |
MylesBorinsforce-pushed the archive-changelog branch from 6fd28c4 to af9d82bCompareMylesBorins commented Apr 22, 2016
updated. The caveat at the bottom now lists all the change logs that can be found in the archive. It is worth mentioning that the CHANGELOG is now at 700k. We'll hit the limit again soon enough and I don't think including all the headers will scale. That being said I think it is a good step for now |
jasnell commented Apr 22, 2016
I'm wondering if we shouldn't move to having the CHANGELOG.md only show the current changelogs for the active releases and move all previous changelogs to individual archive files. It would make things a bit more difficult but if each release has it's own changelog file then the links should always remain stable. |
MylesBorins commented Apr 22, 2016
@jasnell I like that idea quite a bit. How would that affect porting the changelog between release stream? Would each stream have only the latest release in it's changelog and master would have the latest for all actively maintained channels? |
Fishrock123 commented Apr 23, 2016
Imo, we should do archives in I disagree with having just a separate "archive" file though. These ought to be separated by year, but I have not have the time to do it quite yet. (Some older entries are ordered by-version and not by-date.)
yes. We should consider how we go forward with this. Perhaps we should have the root changelog only have heading links to the year-sorted versions? |
jbergstroem commented Apr 24, 2016
How about splitting up changes in majors? (0.12.x, 4.x, 5.x, etc) |
Fishrock123 commented Apr 24, 2016
@jbergstroem We discussed that previously and iirc people didn't like the idea. It's harder to tell when what happened. |
claudiorodriguez commented Apr 25, 2016
After reading up on it, +1 on having archives in |
estliberitasforce-pushed the master branch 2 times, most recently from 7da4fd4 to c7066fbCompareMylesBorins commented Apr 26, 2016
since we can't seem to come to an exact agreement, and the changelog is currently broken for viewing on github. Are people ok landing this the way it is an iterating what we do with the archive? I'd like people to be able to read the changelog when v6 drops |
bnoordhuis commented Apr 26, 2016
Sounds good. LGTM. |
silverwind commented Apr 26, 2016
LGTM, let's get this in now! |
MylesBorinsforce-pushed the archive-changelog branch from af9d82b to 3bb4389CompareThe unfortunate has happened, our CHANGELOG is now over 1 MB and cannot be viewed on github. This commit breaks the CHANGELOG into two files so that we can continue to show our changes rendered in the github UI. Closes: nodejs#5533 PR-URL: nodejs#6337 Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
MylesBorinsforce-pushed the archive-changelog branch from 3bb4389 to cc5d976Compare
IMHO this should have had the |
The unfortunate has happened, our CHANGELOG is now over 1 MB and cannot be viewed on github. This commit breaks the CHANGELOG into two files so that we can continue to show our changes rendered in the github UI. Closes: nodejs#5533 PR-URL: nodejs#6337 Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
Fishrock123 commented Apr 30, 2016
Do I need to add a new |
Fishrock123 commented Apr 30, 2016
Ok at least the links "work", but they redirect to "content" that is in no way useful... |
Fishrock123 commented Apr 30, 2016
Fine, I'll spend some of my weekend fixing this too. |
MylesBorins commented Apr 30, 2016
@Fishrock123 this was discussed in #6337 (comment) The changelog was broken in production on our release day and we were having multiple issues opened to let us know. While this change is not where we would like it to be, it was sufficient in causing the minimal breakage while fixing the immediate problem that we were facing. I'm more than happy to do the grunt work of getting this where it needs to be if we can reach a consensus of what needs to be done. |
jasnell commented Apr 30, 2016
+1 @thealphanerd. There are a couple of workable approaches that would
|
The unfortunate has happened, our CHANGELOG is now over 1 MB and cannot be viewed on github. This commit breaks the CHANGELOG into two files so that we can continue to show our changes rendered in the github UI. Closes: #5533 PR-URL: #6337 Reviewed-By: Claudio Rodriguez <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
10 participants
The unfortunate has happened, our CHANGELOG is now over 1 MB and cannot
be viewed on github. This commit breaks the CHANGELOG into two files
so that we can continue to show our changes rendered in the github UI.
Closes: #5533
It is very likely that we don't want to use
CHANGELOG-ARCHIVE.mdas a filename... this is just to get the ball rolling