Auto-deploy JSDocs to gh-pages after jake publish (#201)

Use git-directory-deploy
Use jake for generating docs
This commit is contained in:
Ryan Zimmerman
2016-09-29 13:46:10 -04:00
committed by GitHub
parent e36b7595ed
commit 699b953e43
2 changed files with 22 additions and 3 deletions

View File

@@ -31,6 +31,19 @@ task('minify', function () {
console.log('Minification completed.');
});
task('doc', function (dev) {
jake.rmRf('out');
var p = dev ? '-p' : '';
exec('./node_modules/.bin/jsdoc ' + p + ' -c jsdoc.json lib/* docs/jsdoc/*');
console.log('Documentation generated.');
})
task('docPublish', ['doc'], function () {
console.log('Pushing docs to gh-pages...');
exec('./node_modules/.bin/git-directory-deploy --directory out/');
console.log('Docs published to gh-pages.');
});
publishTask('ejs', ['build'], function () {
this.packageFiles.include([
'Jakefile',
@@ -43,3 +56,9 @@ publishTask('ejs', ['build'], function () {
'test/**'
]);
});
jake.Task.publish.on('complete', function () {
console.log('Updating hosted docs...');
console.log('If this fails, run jake docPublish to re-try.');
jake.Task.docPublish.invoke();
});

View File

@@ -23,12 +23,12 @@
"devDependencies": {
"browserify": "^13.0.1",
"eslint": "^3.0.0",
"git-directory-deploy": "^1.5.1",
"istanbul": "~0.4.3",
"jake": "^8.0.0",
"jsdoc": "^3.4.0",
"lru-cache": "^4.0.1",
"mocha": "3.0.2",
"rimraf": "^2.2.8",
"uglify-js": "^2.6.2"
},
"engines": {
@@ -38,7 +38,7 @@
"test": "mocha",
"lint": "eslint \"**/*.js\" Jakefile",
"coverage": "istanbul cover node_modules/mocha/bin/_mocha",
"doc": "rimraf out && jsdoc -c jsdoc.json lib/* docs/jsdoc/*",
"devdoc": "rimraf out && jsdoc -p -c jsdoc.json lib/* docs/jsdoc/*"
"doc": "jake doc",
"devdoc": "jake doc[dev]"
}
}