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

doc: add an LTS-LTS changelog #31261

Closed
wants to merge 2 commits into from

Conversation

HarshithaKP
Copy link
Member

document notable changes between v10 to v12 for easy consumption
fixes: #26891

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

document notable changes between v10 to v12 for easy consumption
fixes: nodejs#26891
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 8, 2020
@BridgeAR BridgeAR requested a review from Trott January 9, 2020 22:09
@jasnell
Copy link
Member

jasnell commented Jan 10, 2020

Hmm... if we're going to do this we should do it consistently for all majors. @nodejs/releasers thoughts?

@jasnell
Copy link
Member

jasnell commented Jan 10, 2020

In general, I appreciate the intention of this, but there are a number of issues:

  1. Every major release changelog already contains a complete listing of all semver-major changes since the last major and the minors are already included. What might be better than a document like this is a blog post that is automatically assembled with a complete listing of the semver-major and minor changes.

  2. Given that there are no links to any of the changes, it's really not easy to track the changes back to the relevant context. That is, the existing changelog provides a lot more detail.

I do think it would be great to iterate on our release notes, however, and I know that @BridgeAR has had some thoughts on this.

@richardlau
Copy link
Member

For the specific Node.js 10->12 notable changes, @bnb put together https://nodejs.org/en/blog/uncategorized/10-lts-to-12-lts/ (nodejs/nodejs.org#2701).

@HarshithaKP
Copy link
Member Author

I was trying to help here after reviewing #26891 that had several thumbs ups and no objections.
w.r.t to linked blog, I did not see that earlier, but these are the key changes:

  • I don’t have a section most notable changes
  • I kept all notable changes, segregated based on subsystems
  • I removed the full list of commits
    the aim is to achieve easy discovery and easy consumption.

@Trott
Copy link
Member

Trott commented Jan 10, 2020

@Ginden Would the document added in this PR be useful for you? I'm thinking probably not because it doesn't link to descriptions of the changes etc., but I may be making incorrect assumptions.

@HarshithaKP
Copy link
Member Author

Closing this, as @Ginden (original issue raiser) is happy with the original documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add LTS changelog
5 participants