| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
Sorry, something went wrong.
|
We can't get rid of CHANGELOG.md. That will break too many links. Imo it should contain only the headers (for links) which then contain a link to where it actually is. A redirect, per se. Maybe the latest LTS & Current streams should have their actual contexts in there too and only be archived later? That would be the most user-friendly. EDIT: github diff made it look like it was deleted... I'd be ok with this format but we should also but the headers with links in the content below that so that existing links to it actually work. It's also quite confusing to have the main changelog by date and these by version though. I'd like to hear more discussion on that personally. |
Sorry, something went wrong.
|
v5 changelog rendered: https://github.com/jasnell/node/blob/changelog-partition/doc/changelogs/CHANGELOG_V5.md |
Sorry, something went wrong.
This certainly does not get rid of the root CHANGELOG.md.
Very well. Done.
The main changelog is not ordered by date. If you look at the new changelog page that I linked to in the PR description it is organized by version, just like the individual version pages. Per your request, I've added back in the original headers with links to the new locations. I preserved the existing date order of those. I personally find it less appealing but it works I guess. |
Sorry, something went wrong.
|
@jasnell it looks like you have the wrong date in the v5 changelog. It says June 2015 not 2016 |
Sorry, something went wrong.
|
So overall I like the direction this is heading... my only contention would be whether or not the latest release line should be in the primary changelog. Although that could get weird between release streams. It seems to me like we should likely be keeping the release streams specific changelog as the root directory changelog in that release. e.g. doc/CHANGELOG_V4.md would simply be CHANGELOG in v4.x. This would make cherry picking the changelog changes a bit more complicated... but making a patch and changing the path would not be terribly difficult, this could easily be make a bash one-liner. I would like to see this change come with at least a first pass at documenting the new changelog process. I think that we are most of the way there (in the main changelog), but it should likely address the difference in the changelog between release streams if there will be one. |
Sorry, something went wrong.
|
I went with the current approach because it would be marginally easier to manage the changelog edits across streams (e.g. v6 changes would always go to the CHANGELOG_V6 file, v4 changes would always go to the CHANGELOG_V4 file). Doing it this way means we don't have to move things around when we do a new major, we just create a new doc/changelog/CHANGELOG_V* file, add the column to the table on CHANGELOG.md and off we go. In the v5.x branch, we'd only pull back changes to CHANGELOG_V5, CHANGELOG_V4, CHANGELOG_V012 and CHANGELOG_V010 files. To be honest, I think it should actually simplify the cherry picking of edits a tad easier. But that's just my opinion ;-) |
Sorry, something went wrong.
|
I'm up for seeing how that works and iterating if it shows to have ways to improve 😄 |
Sorry, something went wrong.
|
Fairly simple: Let's say we do another release in v5. The current process is to update the changelog.md in the v5.x branch and cherry pick that commit to master's changelog.md. The process would be no different here:
|
Sorry, something went wrong.
|
This seems fine to me.
I'd be inclined to agree with this, latest Current and latest LTS line maybe? |
Sorry, something went wrong.
|
I see no real value in that and it would just making cherry-picking and updating for each release more difficult. The release announcements can be made to point to the relevant CHANGELOG_V#.md files where the content would either end up just being duplicated or we'd have to throw in an extra step to move it. -1 to having the latest release line changlog in the root changelog file. |
Sorry, something went wrong.
There was a problem hiding this comment.
This is what I was referring to before, that will be broken in release streams.
I don't think we need to include the links to the other change logs... thoughts?
Sorry, something went wrong.
There was a problem hiding this comment.
Why would these be broken? when we port this to the other release streams we simply pull out the links that don't apply to that stream :-) ... so in v4.x, there wouldn't be links to the v5 or v6 pages... update: or we'd make those point to the right branches
Sorry, something went wrong.
There was a problem hiding this comment.
Reasonable... and then when we port changes from releases back to master there will be no conflicts... makes sense
Sorry, something went wrong.
|
nit addressed, LGTM. I'll be landing this in the afternoon as long as no one objects edit: waiting on the ctc to discuss |
Sorry, something went wrong.
|
@thealphanerd ... hold off on landing this one until @nodejs/ctc has had more time to review please :-) |
Sorry, something went wrong.
|
no probremo 😄 |
Sorry, something went wrong.
|
The CTC discussed this and had no objections to this moving forward. I will be doing a bit more work on it, however. Putting the in progress label on. Will remove it when I think it's ready to go. |
Sorry, something went wrong.
|
@nodejs/ctc @nodejs/documentation... this should be ready to go. PTAL |
Sorry, something went wrong.
|
LGTM |
Sorry, something went wrong.
|
@jasnell is there a reason to keep the CHANGELOG archive if it is a dupe of the data found in the other changelogs? Other than that nit LGTM |
Sorry, something went wrong.
|
@thealphanerd ... it's not a dup. The changelog archive contains everything pre-io.js. |
Sorry, something went wrong.
|
@nodejs/ctc ... Please take a final look. If there are no further comments or nits by tomorrow I will get this landed. |
Sorry, something went wrong.
|
lgtm |
Sorry, something went wrong.
|
I'm not sure if this was addressed:
I'm seeing something above, but I'm not following:
Why? We've only fully maintained the changelog in master until now. Perhaps we should add language stating that it is only fully maintained in master? |
Sorry, something went wrong.
|
@Fishrock123 ... #6503 (comment) describes the workflow. Are you wanting me to add it to the releases.md doc in this PR? |
Sorry, something went wrong.
|
Notes added to releases.md |
Sorry, something went wrong.
|
LGTM |
Sorry, something went wrong.
The changelog was getting rather huge and difficult to manage. It also wasn't very useful in terms of being able to quickly find specific Node.js versions, or tracking the history for a single major release stream. This reorganizes the changelog by versions separated out over multiple files. An index of the most recent versions is provided in the main log. PR-URL: #6503 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
PR-URL: #6503 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sorry, something went wrong.
|
Marking this for LTS watch and land-on for all streams. It will need to be backported, however. I will do so soonish. |
Sorry, something went wrong.
|
@jasnell how do you plan on handling the differences between 0.12 and v4 where we switched from ChangeLog to CHANGELOG.md and went full markdown including a rough translation of old entries? Do you want to fully backport all of the markdownage? I'm cool with that fwiw, we'd need to get the release script updated on nodejs/nodejs.org so perhaps drop a note in there if/when you do that. |
Sorry, something went wrong.
|
@rvagg, @jasnell already did that. See nodejs/nodejs.org#733. |
Sorry, something went wrong.
|
It would be nice if the markdown changelog could be backported to 0.10 and 0.12 as it will simpliy the release script a bit. |
Sorry, something went wrong.
PR-URL: #6503 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
The changelog was getting rather huge and difficult to manage. It also wasn't very useful in terms of being able to quickly find specific Node.js versions, or tracking the history for a single major release stream. This reorganizes the changelog by versions separated out over multiple files. An index of the most recent versions is provided in the main log. PR-URL: #6503 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
@jasnell do we still want to backport this? |
Sorry, something went wrong.
|
Eventually. I'd say it's a fairly low priority. |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
Checklist
Affected core subsystem(s)
doc (changelog)
Description of change
/cc @nodejs/documentation @nodejs/ctc @thealphanerd
This is a proposed refactoring of the changelog. As reported by #6363 and #6358, the changelog had grown too large to be visible on github. It was also almost completely unusable in terms of quickly finding information for any single release or tracking changes for specific release streams. A temporary fix was landed in #6337 just to make sure the most recent changelogs could be viewed in Github.
To see how the proposed change would look in practice, visit: https://github.com/jasnell/node/blob/changelog-partition/CHANGELOG.md
This PR reorganizes the changelog by release stream, and brings the following benefits:
The downsides of this change are: