-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
chore: update CHANGELOG automation to use conventional-changelog #3669
Conversation
Output looks like the following. 5.12.3 (2016-10-05)Features
Bug Fixes
Chores
Documentation
Tests
|
Looks great! 👍 |
@@ -31,7 +32,7 @@ module.exports = function(grunt) { | |||
release: { | |||
tag_name: 'v'+ version.full, | |||
name: version.full, | |||
body: chg.find(version.full).changesRaw | |||
body: nodeCli.exec('conventional-changelog', '-p videojs', {silent: true}).output |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
im not sure its worth using shelljs-nodecli
for this, shouldn't we just use shelljs
and point to path.join(__dirname, '..', 'node_modules', '.bin', 'conventional-changelog')
. My reasoning here is that shelljs-nodecli
is not very heavily used, spin off modules are usually not kept up to date with the parent, and I don't even see a git repo for it on npm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a valid concern. The repo is available here, I think it's just missing from the package.json. Also, nicholas has a good track record of maintaining modules or giving it away to other maintainers to help out (see eslint as an example). In addition, I think at this point shelljs-nodecli
is feature complete and there isn't much necessary to do with it; for example, it hasn't been updated in 3 years but still works great.
In addition, it will instead encapsulate the whole thing of running a node binary easily, so, we don't have to worry about how to run it properly or get to the binary, we only need to think about how to use conventional-changelog
.
Hopefully, this addresses your concerns.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that works then
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Hmm, I just got:
After this change. Probably because i don't have ./node_modules/.bin on my path. |
Description
This updates our changelog automation to use conventinoal changelog. Ultimately, it will make it easier to merge PRs because it won't require the use of the contrib tool.
It uses the videojs preset
Specific Changes proposed
CHANGELOG.md
shelljs-nodecli
to executeconventional-changelog -p videojs
which prints out the current changelog item.changelog
npm script to re-generate the changelognpm run changelog
incontrib.json
for releases