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

Changelog #191

Closed
strugee opened this issue Mar 26, 2019 · 14 comments · Fixed by #253 · May be fixed by mike-north/devcert#45 or sekikn/avro#9
Closed

Changelog #191

strugee opened this issue Mar 26, 2019 · 14 comments · Fixed by #253 · May be fixed by mike-north/devcert#45 or sekikn/avro#9
Assignees
Labels

Comments

@strugee
Copy link

strugee commented Mar 26, 2019

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
Copy link

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
Copy link

eight04 commented Jun 5, 2019

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

@silkentrance
Copy link
Collaborator

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
Copy link
Collaborator

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

no.

@raszi
Copy link
Owner

raszi commented Apr 9, 2020

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
Copy link
Collaborator

@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
Copy link
Collaborator

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
Copy link
Collaborator

Will look into this, closing for now.

@silkentrance
Copy link
Collaborator

silkentrance commented Apr 28, 2020

I have found the time for looking into this.

github-changelog

  • uses commit messages for classifying the nature of the commit
  • in the past we did not care about any conventions when creating these messages, so the overall output is quite messy and the result is not beautiful

lerna-changelog

  • creates beautiful results and we are also able to change the past by labelling our past pull requests

v0.2.0 (2020-04-25)

🚀 Enhancement

🐛 Bug Fix

Committers: 2

v0.1.0 (2019-03-20)

🚀 Enhancement

📝 Documentation

Committers: 6

@silkentrance silkentrance reopened this Apr 28, 2020
@silkentrance
Copy link
Collaborator

silkentrance commented Apr 28, 2020

@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
Copy link
Collaborator

@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
Copy link
Owner

raszi commented Apr 28, 2020

Looks good!

@silkentrance
Copy link
Collaborator

Great, I was just preparing a PR for this.

@silkentrance
Copy link
Collaborator

PR #253

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment