Copy dist files to root + add package/bower tasks (#202)

Copy dist files to root + add package/bower tasks

Author: jledentu

.gitignore

@@ -5,9 +5,12 @@ custom/*
 
 docs/index.md
 
+bower.json
 bower_components/
 
 coverage/*
 
 nbproject/*
 dist/
+chartjs-plugin-zoom.js
+chartjs-plugin-zoom.min.js

.npmignore

@@ -0,0 +1,9 @@
+/.git
+/.github
+/dist/*.zip
+/node_modules
+
+.DS_Store
+.gitignore
+.idea
+.travis.yml

.travis.yml

@@ -1,25 +1,35 @@
 language: node_js
 node_js:
-  - "6.2"
-
-before_install:
-  - "export CHROME_BIN=/usr/bin/google-chrome"
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
-
-before_script:
-  - npm install
+  - "lts/*"
 
 script:
   - gulp lint
+  - gulp build
+  - gulp package
+  - gulp bower
 
-sudo: required
-dist: trusty
+# IMPORTANT: scripts require GITHUB_AUTH_TOKEN and GITHUB_AUTH_EMAIL environment variables
+# IMPORTANT: scripts has to be set executables in the Git repository (error 127)
+# https://github.com/travis-ci/travis-ci/issues/5538#issuecomment-225025939
 
-addons:
-  firefox: latest
-  apt:
-    sources:
-      - google-chrome
-    packages:
-      - google-chrome-stable
+deploy:
+  - provider: script
+    script: ./scripts/release.sh
+    skip_cleanup: true
+    on:
+      branch: release
+  - provider: releases
+    api_key: $GITHUB_AUTH_TOKEN
+    file:
+      - "./dist/chartjs-plugin-zoom.js"
+      - "./dist/chartjs-plugin-zoom.min.js"
+      - "./dist/chartjs-plugin-zoom.zip"
+    skip_cleanup: true
+    on:
+      tags: true
+  - provider: npm
+    email: $NPM_AUTH_EMAIL
+    api_key: $NPM_AUTH_TOKEN
+    skip_cleanup: true
+    on:
+      tags: true

MAINTAINING.md

@@ -0,0 +1,33 @@
+# Maintaining
+
+## Release Process
+
+Chart.js relies on [Travis CI](https://travis-ci.org/) to automate the library [releases](https://github.com/chartjs/chartjs-plugin-zoom/releases).
+
+### Releasing a New Version
+
+1. draft release notes on [GitHub](https://github.com/chartjs/chartjs-plugin-zoom/releases/new) for the upcoming tag
+1. update `master` `package.json` version using [semver](https://semver.org/) semantic
+1. merge `master` into the `release` branch
+1. follow the build process on [Travis CI](https://travis-ci.org/chartjs/chartjs-plugin-zoom)
+
+> **Note:** if `master` is merged in `release` with a `package.json` version that already exists, the tag creation fails and the release process is aborted.
+
+### Automated Tasks
+
+Merging into the `release` branch kicks off the automated release process:
+
+* build of the `dist/*.js` files
+* `dist/*.js` are copied to the root directory
+* `bower.json` is generated from `package.json`
+* `dist/*.js` and `bower.json` are added to a detached branch
+* a tag is created from the `package.json` version
+* tag (with dist files) is pushed to GitHub
+
+Creation of this tag triggers a new build:
+
+* `chartjs-plugin-zoom.zip` package is generated, containing dist files and examples
+* `dist/*.js` and `chartjs-plugin-zoom.zip` are attached to the GitHub release (downloads)
+* a new npm package is published on [npmjs](https://www.npmjs.com/package/chartjs-plugin-zoom)
+
+Finally, [cdnjs](https://cdnjs.com/libraries/chartjs-plugin-zoom) is automatically updated from the npm release.

gulpfile.js

@@ -1,15 +1,21 @@
-var gulp = require('gulp'),
-    eslint = require('gulp-eslint'),
-    util = require('gulp-util'),
-    htmllint = require('gulp-htmllint'),
-    inquirer = require('inquirer'),
-    semver = require('semver'),
-    fs = require('fs'),
-    {exec} = require('child_process'),
-    package = require('./package.json');
+var gulp = require('gulp');
+var eslint = require('gulp-eslint');
+var file = require('gulp-file');
+var util = require('gulp-util');
+var htmllint = require('gulp-htmllint');
+var replace = require('gulp-replace');
+var streamify = require('gulp-streamify');
+var zip = require('gulp-zip');
+var inquirer = require('inquirer');
+var semver = require('semver');
+var fs = require('fs');
+var {exec} = require('child_process');
+var merge = require('merge-stream');
+var pkg = require('./package.json');
 
 var srcDir = './src/';
 var srcFiles = srcDir + '**.js';
+var outDir = './dist/';
 
 function run(bin, args, done) {
   var exe = '"' + process.execPath + '"';
@@ -21,27 +27,71 @@ function run(bin, args, done) {
   ps.on('close', () => done());
 }
 
-gulp.task('build', buildTask);
+gulp.task('bower', bowerTask);
+gulp.task('build', gulp.series(rollupTask, copyDistFilesTask));
+gulp.task('package', packageTask);
 gulp.task('bump', bumpTask);
 gulp.task('lint-html', lintHtmlTask);
 gulp.task('lint-js', lintJsTask);
 gulp.task('lint', gulp.parallel('lint-html', 'lint-js'));
 gulp.task('watch', watchTask);
 gulp.task('default', gulp.parallel('lint', 'build', 'watch'));
 
-function buildTask(done) {
+/**
+ * Generates the bower.json manifest file which will be pushed along release tags.
+ * Specs: https://github.com/bower/spec/blob/master/json.md
+ */
+function bowerTask() {
+  var json = JSON.stringify({
+    name: pkg.name,
+    description: pkg.description,
+    homepage: pkg.homepage,
+    license: pkg.license,
+    version: pkg.version,
+    main: outDir + pkg.name + '.js'
+  }, null, 2);
+
+  return file('bower.json', json, {src: true})
+    .pipe(gulp.dest('./'));
+}
+
+function rollupTask(done) {
   run('rollup/bin/rollup', ['-c'], done);
 }
 
+/**
+ * Copy the files from `/dist` to the root directory.
+ * @todo remove at version 1.0
+ */
+function copyDistFilesTask() {
+  return gulp.src(outDir + '*.js')
+    .pipe(gulp.dest('./'));
+}
+
+function packageTask() {
+  return merge(
+    // gather "regular" files landing in the package root
+    gulp.src([outDir + '*.js', 'LICENSE.md']),
+
+    // since we moved the dist files one folder up (package root), we need to rewrite
+    // samples src="../dist/ to src="../ and then copy them in the /samples directory.
+    gulp.src('./samples/**/*', {base: '.'})
+      .pipe(streamify(replace(/src="((?:\.\.\/)+)dist\//g, 'src="$1')))
+  )
+  // finally, create the zip archive
+  .pipe(zip(pkg.name + '.zip'))
+  .pipe(gulp.dest(outDir));
+}
+
 /*
  *  Usage : gulp bump
  *  Prompts: Version increment to bump
  *  Output: - New version number written into package.json
  */
 function bumpTask(complete) {
-  util.log('Current version:', util.colors.cyan(package.version));
+  util.log('Current version:', util.colors.cyan(pkg.version));
   var choices = ['major', 'premajor', 'minor', 'preminor', 'patch', 'prepatch', 'prerelease'].map(function(versionType) {
-    return versionType + ' (v' + semver.inc(package.version, versionType) + ')';
+    return versionType + ' (v' + semver.inc(pkg.version, versionType) + ')';
   });
   inquirer.prompt({
     type: 'list',
@@ -50,13 +100,13 @@ function bumpTask(complete) {
     choices: choices
   }).then(function(res) {
     var increment = res.version.split(' ')[0],
-      newVersion = semver.inc(package.version, increment);
+      newVersion = semver.inc(pkg.version, increment);
 
     // Set the new versions into the package object
-    package.version = newVersion;
+    pkg.version = newVersion;
 
     // Write these to their own files, then build the output
-    fs.writeFileSync('package.json', JSON.stringify(package, null, 2));
+    fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2));
 
     complete();
   });