From d4e89d2adc58a7ea3eca17b472a472cbc5cbe7a4 Mon Sep 17 00:00:00 2001 From: Gary Katsevman Date: Thu, 6 Oct 2016 14:09:48 -0400 Subject: [PATCH] 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 --- CHANGELOG.md | 8 -------- build/grunt.js | 3 ++- contrib.json | 4 ++-- package.json | 6 +++++- 4 files changed, 9 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1f7be8d35..fe0c75fab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,3 @@ -CHANGELOG -========= - -## HEAD (Unreleased) -_(none)_ - --------------------- - ## 5.12.2 (2016-09-28) * Changes from 5.11.7 on the 5.12 branch diff --git a/build/grunt.js b/build/grunt.js index 25556b11f..ddf86e219 100644 --- a/build/grunt.js +++ b/build/grunt.js @@ -1,5 +1,6 @@ import {gruntCustomizer, gruntOptionsMaker} from './options-customizer.js'; import chg from 'chg'; +import nodeCli from 'shelljs-nodecli'; module.exports = function(grunt) { require('time-grunt')(grunt); @@ -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 }, }, files: { diff --git a/contrib.json b/contrib.json index c72c91a2d..dbae370f8 100644 --- a/contrib.json +++ b/contrib.json @@ -280,7 +280,7 @@ [ "git checkout -b temp-release-branch master","Create a temporary branch for the dist" ], [ "grunt version:{{release_type}}", "Bump package versions" ], [ "./build/bin/version", "Return the current VJS Version from the package.json file", "version" ], - [ "grunt chg-release:{{version}}", "Update the changelog with the new release" ], + [ "npm run changelog", "Update the changelog with the new release" ], [ "git commit -am 'v{{version}}'", "Add and commit the package changes" ], [ "git checkout master", "Checkout the developmet branch" ], [ "git merge temp-release-branch", "Merge package changes into the dev brach" ], @@ -306,7 +306,7 @@ [ "grunt test", "Run tests" ], [ "grunt version:{{release_type}}", "Bump package versions" ], [ "./build/bin/version", "Return the current VJS Version from the package.json file", "version" ], - [ "grunt chg-release:{{version}}", "Update the changelog with the new release" ], + [ "npm run changelog", "Update the changelog with the new release" ], [ "git commit -am 'v{{version}}'", "Add and commit the package changes" ], [ "git push upstream stable", "Push the release branch changes to the repo" ], [ "git checkout -b temp-release-branch stable","Create a temporary branch for the dist" ], diff --git a/package.json b/package.json index 55d58f8e0..56e6a778b 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,7 @@ "homepage": "http://videojs.com", "author": "Steve Heffernan", "scripts": { + "changelog": "conventional-changelog -p videojs -i CHANGELOG.md -s", "build": "grunt dist", "change": "grunt chg-add", "clean": "grunt clean", @@ -55,13 +56,15 @@ "browserify-versionify": "^1.0.4", "bundle-collapser": "^1.2.1", "chg": "^0.3.2", + "conventional-changelog-cli": "^1.2.0", + "conventional-changelog-videojs": "^3.0.0", "es5-shim": "^4.1.3", "es6-shim": "^0.35.1", "ghooks": "^1.3.2", "gkatsev-grunt-sass": "^1.1.1", "grunt": "^0.4.4", - "grunt-babel": "^6.0.0", "grunt-accessibility": "^4.1.0", + "grunt-babel": "^6.0.0", "grunt-banner": "^0.4.0", "grunt-browserify": "3.5.1", "grunt-cli": "~0.1.13", @@ -97,6 +100,7 @@ "markdown-table": "^1.0.0", "proxyquireify": "^3.0.0", "qunitjs": "^1.23.1", + "shelljs-nodecli": "^0.1.1", "sinon": "^1.16.1", "time-grunt": "^1.1.1", "uglify-js": "~2.7.3",