Joi: Add Changelog

Created on 7 Sep 2017  路  10Comments  路  Source: sideway/joi

Can you please add a changelog file to the project?

Thanks.

documentation feature

Most helpful comment

This only proves that people don't know how to search issues.

@Marsup I think a simple thing would be to include just a link to the issue that relates to those particular release notes. Personally I usually just use changelog on NPM to gather a quick list of the recent commits with links to the PRs. Something like that to copy/paste in release notes (or a file of some sort) might be easy to do and useful.

All 10 comments

All semver major releases have Release Notes found here.

All the other changes can be found here https://github.com/hapijs/joi/commits/master since there aren't too many commits is quite easy to scan through
or you can do https://github.com/hapijs/joi/compare/v10.5.2...v10.6.0

@WesTyler @AdrieanKhisbe why don't you explain that directly in a changelog.md ?

Because many users are expecting a changelog.md, a history.md or GitHub release descriptions, See https://github.com/hapijs/joi/issues/289, https://github.com/hapijs/joi/issues/630, https://github.com/hapijs/joi/issues/673 and https://github.com/hapijs/joi/issues/1297

This only proves that people don't know how to search issues. But I'd be willing to add that if it helps with that confusion.

@Marsup when you have hundreds of dependencies to manage and update, it is very convenient to check for a changelog or even better, for GitHub release description

By the way, why don't you juste copy/paste this issue (with a release description) into that (you can copy the exact same markdown) ?

Most of JavaScript projects on GitHub are using this technique..

And isn't issues meant to be different that a release description (or milestone)?

This only proves that people don't know how to search issues.

@Marsup I think a simple thing would be to include just a link to the issue that relates to those particular release notes. Personally I usually just use changelog on NPM to gather a quick list of the recent commits with links to the PRs. Something like that to copy/paste in release notes (or a file of some sort) might be easy to do and useful.

@DavidTPate that is an amazing tip :O

I'll check, could it be automated on npm version?

@Marsup With some coding support I could definitely see it being able to be done in a single command in an automated fashion. I've personally been looking at moving over to https://www.npmjs.com/package/unleash from Netflix instead.

I dislike semantic commits quite a lot, not sure if something will ever change my mind about it.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ashrafkm picture ashrafkm  路  3Comments

farwayer picture farwayer  路  3Comments

PaunPrashant picture PaunPrashant  路  3Comments

alekbarszczewski picture alekbarszczewski  路  3Comments

normancarcamo picture normancarcamo  路  3Comments