Skip to content

Commit d4e89d2

Browse files
authored
chore: update CHANGELOG automation to use conventional-changelog (#3669)
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 https://github.com/videojs/conventional-changelog-videojs/blob/master/convention.md
1 parent 920c54a commit d4e89d2

File tree

4 files changed

+9
-12
lines changed

4 files changed

+9
-12
lines changed

CHANGELOG.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
CHANGELOG
2-
=========
3-
4-
## HEAD (Unreleased)
5-
_(none)_
6-
7-
--------------------
8-
91
## 5.12.2 (2016-09-28)
102
* Changes from 5.11.7 on the 5.12 branch
113

build/grunt.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import {gruntCustomizer, gruntOptionsMaker} from './options-customizer.js';
22
import chg from 'chg';
3+
import nodeCli from 'shelljs-nodecli';
34

45
module.exports = function(grunt) {
56
require('time-grunt')(grunt);
@@ -31,7 +32,7 @@ module.exports = function(grunt) {
3132
release: {
3233
tag_name: 'v'+ version.full,
3334
name: version.full,
34-
body: chg.find(version.full).changesRaw
35+
body: nodeCli.exec('conventional-changelog', '-p videojs', {silent: true}).output
3536
},
3637
},
3738
files: {

contrib.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@
280280
[ "git checkout -b temp-release-branch master","Create a temporary branch for the dist" ],
281281
[ "grunt version:{{release_type}}", "Bump package versions" ],
282282
[ "./build/bin/version", "Return the current VJS Version from the package.json file", "version" ],
283-
[ "grunt chg-release:{{version}}", "Update the changelog with the new release" ],
283+
[ "npm run changelog", "Update the changelog with the new release" ],
284284
[ "git commit -am 'v{{version}}'", "Add and commit the package changes" ],
285285
[ "git checkout master", "Checkout the developmet branch" ],
286286
[ "git merge temp-release-branch", "Merge package changes into the dev brach" ],
@@ -306,7 +306,7 @@
306306
[ "grunt test", "Run tests" ],
307307
[ "grunt version:{{release_type}}", "Bump package versions" ],
308308
[ "./build/bin/version", "Return the current VJS Version from the package.json file", "version" ],
309-
[ "grunt chg-release:{{version}}", "Update the changelog with the new release" ],
309+
[ "npm run changelog", "Update the changelog with the new release" ],
310310
[ "git commit -am 'v{{version}}'", "Add and commit the package changes" ],
311311
[ "git push upstream stable", "Push the release branch changes to the repo" ],
312312
[ "git checkout -b temp-release-branch stable","Create a temporary branch for the dist" ],

package.json

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"homepage": "http://videojs.com",
1717
"author": "Steve Heffernan",
1818
"scripts": {
19+
"changelog": "conventional-changelog -p videojs -i CHANGELOG.md -s",
1920
"build": "grunt dist",
2021
"change": "grunt chg-add",
2122
"clean": "grunt clean",
@@ -55,13 +56,15 @@
5556
"browserify-versionify": "^1.0.4",
5657
"bundle-collapser": "^1.2.1",
5758
"chg": "^0.3.2",
59+
"conventional-changelog-cli": "^1.2.0",
60+
"conventional-changelog-videojs": "^3.0.0",
5861
"es5-shim": "^4.1.3",
5962
"es6-shim": "^0.35.1",
6063
"ghooks": "^1.3.2",
6164
"gkatsev-grunt-sass": "^1.1.1",
6265
"grunt": "^0.4.4",
63-
"grunt-babel": "^6.0.0",
6466
"grunt-accessibility": "^4.1.0",
67+
"grunt-babel": "^6.0.0",
6568
"grunt-banner": "^0.4.0",
6669
"grunt-browserify": "3.5.1",
6770
"grunt-cli": "~0.1.13",
@@ -97,6 +100,7 @@
97100
"markdown-table": "^1.0.0",
98101
"proxyquireify": "^3.0.0",
99102
"qunitjs": "^1.23.1",
103+
"shelljs-nodecli": "^0.1.1",
100104
"sinon": "^1.16.1",
101105
"time-grunt": "^1.1.1",
102106
"uglify-js": "~2.7.3",

0 commit comments

Comments
 (0)