Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

possibly archive "old" CHANGELOG.md entries (by year?) #5533

Closed
Fishrock123 opened this issue Mar 2, 2016 · 14 comments
Closed

possibly archive "old" CHANGELOG.md entries (by year?) #5533

Fishrock123 opened this issue Mar 2, 2016 · 14 comments
Labels
discuss Issues opened for discussions and feedbacks. doc Issues and PRs related to the documentations.

Comments

@Fishrock123
Copy link
Contributor

CHANGELOG.md is huge. My local markdown viewer now locks up attempting to preview it. I think we should begin archiving it by year.

cc @nodejs/ctc?

@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. discuss Issues opened for discussions and feedbacks. labels Mar 2, 2016
@Fishrock123
Copy link
Contributor Author

I also just lost a bunch of work to my editor freezing on the preview. 🔥

@rvagg
Copy link
Member

rvagg commented Mar 2, 2016

Maybe you have too much Atom in your life?

@rvagg
Copy link
Member

rvagg commented Mar 2, 2016

fwiw I think it'd be fine to archive it by year in the docs directory as long as each doc points to the next at the end.

@ChALkeR
Copy link
Member

ChALkeR commented Mar 2, 2016

Previous discussion: #2810.

@ChALkeR
Copy link
Member

ChALkeR commented Mar 2, 2016

Actually, splitting per year (and cross-linking them) looks like a much better idea than splitting per major version, so +1 from me on this one.

@Fishrock123
Copy link
Contributor Author

Maybe you have too much Atom in your life?

I assume there will be a point where GitHub will also simply refuse to render it. :P

@MylesBorins
Copy link
Contributor

+1 on the idea of splitting by year.

@silverwind
Copy link
Contributor

I assume there will be a point where GitHub will also simply refuse to render it

That's at 2 MiB, right? 😈

Anyways, +1 on archiving everything pre-4.0 to a file in doc, possibly linking to it.

@ChALkeR
Copy link
Member

ChALkeR commented Mar 3, 2016

@silverwind

Anyways, +1 on archiving everything pre-4.0 to a file in doc, possibly linking to it.

That's by version. Could you clarify, is 2016-02-09, Version 0.12.10 (LTS) pre-4.0 or not? =)

@silverwind
Copy link
Contributor

@ChALkeR Right, that's not going to work with LTS. By age is fine then.

@Fishrock123
Copy link
Contributor Author

Hmmm, this seems a little more tricky than I had anticipated. Is it possible that pre1.0.0 (i.e. in the 0.6-0.9 era) ordered the changelog by version number and not date? I see some out-of-order entries..

@rvagg
Copy link
Member

rvagg commented Mar 8, 2016

possible, I'd +1 a reordering if you want to do that

@MylesBorins
Copy link
Contributor

MylesBorins commented Apr 21, 2016

So it looks like our changelog has finally gotten over 1 MB and github is no longer allowing us to view it :sad:

@jasnell
Copy link
Member

jasnell commented Apr 21, 2016

Let's pull everything out older than a year into an archive file...

MylesBorins pushed a commit to MylesBorins/node that referenced this issue Apr 26, 2016
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]>
jasnell pushed a commit to jasnell/node that referenced this issue Apr 29, 2016
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]>
MylesBorins pushed a commit that referenced this issue May 3, 2016
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issues opened for discussions and feedbacks. doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

6 participants