raszi / node-tmp

Temporary file and directory creator for node.js
MIT License
736 stars 92 forks source link

Changelog #191

Closed strugee closed 4 years ago

strugee commented 5 years ago

This project could use a change log. In particular 0.1.0 has just been released and it's exceedingly difficult to determine what has actually changed in this version compared with the previous release.

See also https://keepachangelog.com. Thanks for maintaining this project!

whollacsek commented 5 years ago

I'm also going through this trying to figure out what changed since 2016. In addition to the change log can we also promote this package to v1.0.0 and get regular minor releases?

Maybe using a tool like https://github.com/zeit/release

eight04 commented 5 years ago

Does anyone have a summary about what has been changed for v0.1.0?

silkentrance commented 4 years ago

I am currently working on incorporating a changelog. ATM this will be hand crafted, since we do not have any commits that would support a standardized way for collecting changelog information in an automated fashion.

silkentrance commented 4 years ago

Does anyone have a summary about what has been changed for v0.1.0?

no.

raszi commented 4 years ago

In my comment https://github.com/raszi/node-tmp/pull/234/files#r377256378 I recommended to the https://github.com/ekataglobal/github-changelog project and I believe all the PRs are formatted correctly for that, so we can generate the changelog anytime.

silkentrance commented 4 years ago

@raszi I reckon that, thanks for the link btw. however, I needed to make this as fast as possible, and doing it by hand and not fiddling around with errs on behalf of github-changelog, I decided otherwise. And I think I tried the solution but it then gave me no suitable results? I will give it another try soon.

silkentrance commented 4 years ago

We are actively using lerna-changelog over at testdeck, however, this requires that all pull requests are labelled with bug, enhancement, ... and so on.

silkentrance commented 4 years ago

Will look into this, closing for now.

silkentrance commented 4 years ago

I have found the time for looking into this.

github-changelog


lerna-changelog


v0.2.0 (2020-04-25)

:rocket: Enhancement

:bug: Bug Fix

Committers: 2

v0.1.0 (2019-03-20)

:rocket: Enhancement

:memo: Documentation

Committers: 6

silkentrance commented 4 years ago

@raszi personally I would go for lerna-changelog as it produces the best results

of course, we will have to go through our pull requests and label them, but this will not take that much of a time.

silkentrance commented 4 years ago

@raszi I invested the time and labelled all merged PRs and here is the result from lerna-changelog

https://gist.github.com/silkentrance/430fd1725279750e5f3f0470de7d120f

This definitely looks great. It misses releases < v0.0.14, though.

Still, awesome result for just 10 minutes time.

raszi commented 4 years ago

Looks good!

silkentrance commented 4 years ago

Great, I was just preparing a PR for this.

silkentrance commented 4 years ago

PR #253