meta: split CHANGELOG into two files #6337

MylesBorins · 2016-04-21T21:07:53Z

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.md as a filename... this is just to get the ball rolling

claudiorodriguez · 2016-04-21T21:26:40Z

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 CHANGELOG-YYYY-MM-DD.md, splitting when a determined filesize is reached?

silverwind · 2016-04-21T21:41:47Z

May I suggest moving the archived file into doc to prevent further pollution of the root directory?

MylesBorins · 2016-04-21T21:44:11Z

@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

ChALkeR · 2016-04-21T22:02:03Z

Previous considerations: #2810, #5533.

Update: ah, sorry, those were already linked, I somehow missed that.

jasnell · 2016-04-21T23:50:53Z

LGTM with moving archive doc into docs dir

evanlucas · 2016-04-22T00:44:00Z

Won't this break links in a lot of blog posts?

MylesBorins · 2016-04-22T00:50:58Z

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

bnoordhuis · 2016-04-22T11:33:08Z

It is very likely that we don't want to use CHANGELOG-ARCHIVE.md as a filename...

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.

MylesBorins · 2016-04-22T22:59:55Z

I've updated the commit.

Everything older than a year is now in doc/CHANGELOG.ARCHIVE.md

I have added a link at the end of the changelog to the archive

jasnell · 2016-04-22T23:22:54Z

@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 · 2016-04-22T23:33:32Z

+1 to what @jasnell sqid

MylesBorins · 2016-04-22T23:49:20Z

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 · 2016-04-22T23:51:37Z

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 · 2016-04-22T23:56:09Z

@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 · 2016-04-23T20:17:08Z

Imo, we should do archives in doc/.

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

Won't this break links in a lot of blog posts?

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 · 2016-04-24T08:29:23Z

How about splitting up changes in majors? (0.12.x, 4.x, 5.x, etc)

Fishrock123 · 2016-04-24T15:21:38Z

@jbergstroem We discussed that previously and iirc people didn't like the idea. It's harder to tell when what happened.

claudiorodriguez · 2016-04-25T23:51:03Z

After reading up on it, +1 on having archives in doc/separated by year.

MylesBorins · 2016-04-26T16:29:29Z

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 · 2016-04-26T16:48:31Z

Sounds good. LGTM.

silverwind · 2016-04-26T18:55:07Z

LGTM, let's get this in now!

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]>

mscdex · 2016-04-26T23:35:42Z

IMHO this should have had the doc: prefix instead of meta:

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 · 2016-04-30T00:11:07Z

Imo, we should do archives in doc/.

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

Won't this break links in a lot of blog posts?

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?

Do I need to add a new blocked or -1 label??

Fishrock123 · 2016-04-30T00:15:08Z

Ok at least the links "work", but they redirect to "content" that is in no way useful...

Fishrock123 · 2016-04-30T00:15:38Z

Fine, I'll spend some of my weekend fixing this too.

MylesBorins · 2016-04-30T00:50:28Z

@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 · 2016-04-30T01:29:15Z

+1 @thealphanerd. There are a couple of workable approaches that would
work. By year is one way, but I think I'd much prefer a separate file per
major. That's a bit more work but manageable. Happy to help!
On Apr 29, 2016 5:50 PM, "Myles Borins" [email protected] wrote:

@Fishrock123 https:/Fishrock123 this was discussed in #6337
(comment)
#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.

—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#6337 (comment)

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]>

MylesBorins mentioned this pull request Apr 21, 2016

V5.11.0 proposal #6322

Closed

claudiorodriguez added the meta Issues and PRs related to the general management of the project. label Apr 21, 2016

mscdex added the doc Issues and PRs related to the documentations. label Apr 21, 2016

MylesBorins force-pushed the archive-changelog branch from 59d81e6 to 4abaf8e Compare April 22, 2016 22:58

MylesBorins force-pushed the archive-changelog branch from 4abaf8e to 6fd28c4 Compare April 22, 2016 23:00

MylesBorins force-pushed the archive-changelog branch from 6fd28c4 to af9d82b Compare April 22, 2016 23:48

MylesBorins mentioned this pull request Apr 24, 2016

Break up CHANGELOG.md? #6358

Closed

addaleax mentioned this pull request Apr 24, 2016

CHANGELOG.md is now too big to view on Github #6363

Closed

estliberitas force-pushed the master branch 2 times, most recently from 7da4fd4 to c7066fb Compare April 26, 2016 05:23

MylesBorins force-pushed the archive-changelog branch from af9d82b to 3bb4389 Compare April 26, 2016 20:14

MylesBorins force-pushed the archive-changelog branch from 3bb4389 to cc5d976 Compare April 26, 2016 20:16

MylesBorins merged commit cc5d976 into nodejs:master Apr 26, 2016

jasnell mentioned this pull request May 1, 2016

doc: refactor the changelog by version #6503

Closed

1 task

This was referenced May 4, 2016

Propose v6.1.0 wrong base please ignore #6556

Closed

Propose v6.1.0 (Openssl update) #6557

Merged

MylesBorins deleted the archive-changelog branch May 12, 2016 18:14

MylesBorins added the dont-land-on-v4.x label Jun 1, 2016

not-an-aardvark mentioned this pull request Aug 17, 2017

split changelog eslint/eslint#9114

Closed

evanw mentioned this pull request Sep 12, 2022

Change log is too large. Split it to separate files? evanw/esbuild#2541

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

meta: split CHANGELOG into two files #6337

meta: split CHANGELOG into two files #6337

MylesBorins commented Apr 21, 2016

claudiorodriguez commented Apr 21, 2016

silverwind commented Apr 21, 2016

MylesBorins commented Apr 21, 2016

ChALkeR commented Apr 21, 2016 •

edited

Loading

jasnell commented Apr 21, 2016

evanlucas commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

bnoordhuis commented Apr 22, 2016 •

edited

Loading

MylesBorins commented Apr 22, 2016

jasnell commented Apr 22, 2016

evanlucas commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

jasnell commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

Fishrock123 commented Apr 23, 2016

jbergstroem commented Apr 24, 2016

Fishrock123 commented Apr 24, 2016

claudiorodriguez commented Apr 25, 2016

MylesBorins commented Apr 26, 2016

bnoordhuis commented Apr 26, 2016

silverwind commented Apr 26, 2016

mscdex commented Apr 26, 2016 •

edited

Loading

Fishrock123 commented Apr 30, 2016

Fishrock123 commented Apr 30, 2016

Fishrock123 commented Apr 30, 2016

MylesBorins commented Apr 30, 2016

jasnell commented Apr 30, 2016

meta: split CHANGELOG into two files #6337

meta: split CHANGELOG into two files #6337

Conversation

MylesBorins commented Apr 21, 2016

claudiorodriguez commented Apr 21, 2016

silverwind commented Apr 21, 2016

MylesBorins commented Apr 21, 2016

ChALkeR commented Apr 21, 2016 • edited Loading

jasnell commented Apr 21, 2016

evanlucas commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

bnoordhuis commented Apr 22, 2016 • edited Loading

MylesBorins commented Apr 22, 2016

jasnell commented Apr 22, 2016

evanlucas commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

jasnell commented Apr 22, 2016

MylesBorins commented Apr 22, 2016

Fishrock123 commented Apr 23, 2016

jbergstroem commented Apr 24, 2016

Fishrock123 commented Apr 24, 2016

claudiorodriguez commented Apr 25, 2016

MylesBorins commented Apr 26, 2016

bnoordhuis commented Apr 26, 2016

silverwind commented Apr 26, 2016

mscdex commented Apr 26, 2016 • edited Loading

Fishrock123 commented Apr 30, 2016

Fishrock123 commented Apr 30, 2016

Fishrock123 commented Apr 30, 2016

MylesBorins commented Apr 30, 2016

jasnell commented Apr 30, 2016

ChALkeR commented Apr 21, 2016 •

edited

Loading

bnoordhuis commented Apr 22, 2016 •

edited

Loading

mscdex commented Apr 26, 2016 •

edited

Loading