Skip to content

Commit 0d4bc16

Browse files
committed
github_changelog_generator => conventional-changelog
github_changelog_generator causes a lot of friction for me due to its Ruby conventions and dependencies. The recent change to require --user and --project if not configured in Rakefile pushed me enough to switch to conventional-changelog, which is more Node-centric. Signed-off-by: Kevin Locke <[email protected]>
1 parent 0d18598 commit 0d4bc16

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Project Template
1010

1111
A Node.js/npm project template with [codecov](https://codecov.io/),
1212
[coveralls](https://coveralls.io/), [ESLint](https://eslint.org/),
13-
[github\_changelog\_generator](https://github.com/github-changelog-generator/github-changelog-generator),
13+
[conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli),
1414
[nyc](https://github.com/istanbuljs/nyc), [JSDoc](http://usejsdoc.org/), and
1515
[mocha](https://mochajs.org/).
1616

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@kevinoid/project-template",
33
"version": "0.0.1",
4-
"description": "A Node.js/npm project template with codecov, coveralls, ESLint, github_changelog_generator, nyc, JSDoc, and mocha.",
4+
"description": "A Node.js/npm project template with codecov, coveralls, ESLint, conventional-changelog, nyc, JSDoc, and mocha.",
55
"keywords": [
66
"project-template",
77
"template"
@@ -20,14 +20,15 @@
2020
},
2121
"//": "All scripts should run in POSIX sh and Windows cmd.exe",
2222
"scripts": {
23+
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -u",
2324
"clean": "rimraf coverage && rimraf doc",
2425
"doc": "npm run doc-js && npm run doc-spec",
2526
"doc-js": "rimraf doc/api && jsdoc -c jsdoc.conf.json .",
2627
"doc-spec": "rimraf doc/spec && mkdir doc/spec && mocha --reporter doc --recursive test | nodecat doc-src/spec/header.xhtml - doc-src/spec/footer.xhtml > doc/spec/index.xhtml",
2728
"lint": "npm run lint-js && npm run lint-doc",
2829
"lint-doc": "jsdoc -t templates/silent -c jsdoc-lint.conf.json . && echo JSDoc passed.",
2930
"lint-js": "eslint --report-unused-disable-directives . && echo ESLint passed.",
30-
"postpublish": "git -C doc push && git push --follow-tags origin master gh-pages && echo Remember to update GitHub Releases from CHANGELOG.md && echo until skywinder/github-changelog-generator#56 is fixed.",
31+
"postpublish": "git -C doc push && git push --follow-tags origin master gh-pages && echo Remember to update GitHub Releases from CHANGELOG.md",
3132
"postversion": "rimraf doc && git clone -b gh-pages -l -q . doc && npm run doc && git -C doc add . && git -C doc commit -n -m \"Docs for v$npm_package_version\"",
3233
"preversion": "npm run test-cov && nyc check-coverage --statements 95 && check-audit && depcheck --ignores greenkeeper-lockfile --ignore-dirs doc && david && git-branch-is master && travis-status -b master -c -w -x && appveyor-status -b master -c -w",
3334
"start": "supervisor --quiet --no-restart-on exit --extensions js,json --ignore test --poll-interval 2000 server.js",
@@ -36,8 +37,8 @@
3637
"test-unit": "mocha --recursive test",
3738
"test-unit-cov": "nyc mocha --recursive test",
3839
"upload-cov": "codecov < ./coverage/lcov.info && coveralls < ./coverage/lcov.info",
39-
"version": "github_changelog_generator -t \"$npm_config_gcg_github_token\" --future-release \"$npm_package_version\" && echo && echo === Please edit CHANGELOG.md as desired, then exit === && echo && $npm_config_shell && git commit -m \"Update CHANGELOG.md for $npm_package_version\" CHANGELOG.md",
40-
"version-deps": "npm install david depcheck git-branch-is npm-audit-resolver travis-status"
40+
"version": "npm run changelog && echo && echo === Please edit CHANGELOG.md as desired, then exit === && echo && $npm_config_shell && git commit -m \"Update CHANGELOG.md for $npm_package_version\" CHANGELOG.md",
41+
"version-deps": "npm install conventional-changelog-cli david depcheck git-branch-is npm-audit-resolver travis-status"
4142
},
4243
"dependencies": {
4344
"yargs": "^14.0.0"

0 commit comments

Comments
 (0)