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

What about CHANGELOG.md #205

Open
1 task
vovs03 opened this issue Nov 10, 2019 · 5 comments
Open
1 task

What about CHANGELOG.md #205

vovs03 opened this issue Nov 10, 2019 · 5 comments

Comments

@vovs03
Copy link

vovs03 commented Nov 10, 2019

❓ What about πŸ“ CHANGELOG.md

If is it possible, it will be cool!

  • CHANGELOG.md
# CHANGELOG

**v.2.3.5**
- `on Sep 30, 2019 `
  - describe

...

**v. 2.3.0**
- `on Jun 26, 2017`
  - describe
@stheine
Copy link

stheine commented Apr 29, 2020

especially, if you do major version updates, like the recent 2.x to 3.x, I'd like to understand if there are breaking changes, so a CHANGELOG would be the natural place to search.

@niftylettuce
Copy link

@bnoordhuis I recommend to use npm i -g [email protected] and np to publish versions, which will auto-open GitHub releases page (similar to release) and provide a changelog for each version, then you wouldn't need a CHANGELOG and your existing releases would have much more detail

@bnoordhuis
Copy link
Owner

@niftylettuce I might start using that from now on, thanks for the tip.

@stheine Really the only change is that using iconv from worker_threads now works (#211) and that required bumping the minimum supported node.js version.

@dr-dimitru
Copy link

GitHub's releases is the great alternative to CHANGELOG file. But it would be great to read why major change happened, like here:

@bnoordhuis ...required bumping the minimum supported node.js version.

What minimum required node.js version now?

@niftylettuce
Copy link

@dr-dimitru see the engines field in package.json https://github.com/bnoordhuis/node-iconv/blob/master/package.json#L15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants