Deploy to GitHub pages (#4256)

Add Travis CI task to deploy the docs, samples and dist files to chartjs.github.io for the `release` and `master` branches. A `latest` symbolic links is also created for each folder to the highest version (or `master` if any).

diff --git a/.gitignore b/.gitignore
index b23981942a572011a1625bcf039c1353522ed9fe..0853b7efd9320b045c4242bc8787d369f41a2863 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
 /custom
 /dist
 /docs/index.md
+/gh-pages
 /node_modules
 .DS_Store
 .idea

diff --git a/.travis.yml b/.travis.yml
index d99266137b610347718884e021720d3658fe3a4f..f0290da2a4467edcc0f72be56729fd1e9cc7a381 100644 (file)
--- a/.travis.yml
+++ b/.travis.yml
@@ -13,6 +13,7 @@ before_script:
 script:
   - gulp build
   - gulp test --coverage
+  - gulp docs
   - gulp package
   - gulp bower
   - cat ./coverage/lcov.info | ./node_modules/.bin/coveralls
@@ -31,16 +32,22 @@ addons:
     packages:
       - google-chrome-stable
 
-deploy:
-# Creates a tag containing dist files and bower.json
-# Requires GITHUB_AUTH_TOKEN and GITHUB_AUTH_EMAIL environment variables
-# IMPORTANT: the script has to be set executable in the Git repository (error 127)
+
+# 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
+
+deploy:
 - provider: script
   script: ./scripts/release.sh
   skip_cleanup: true
   on:
     branch: release
+- provider: script
+  script: ./scripts/deploy.sh
+  skip_cleanup: true
+  on:
+    all_branches: true
 - provider: releases
   api_key: $GITHUB_AUTH_TOKEN
   file:

diff --git a/scripts/deploy.sh b/scripts/deploy.sh
new file mode 100755 (executable)
index 0000000..b0edddc
--- /dev/null
+++ b/scripts/deploy.sh
@@ -0,0 +1,68 @@
+#!/bin/bash
+
+set -e
+
+TARGET_DIR='gh-pages'
+TARGET_BRANCH='master'
+TARGET_REPO_URL="https://$GITHUB_AUTH_TOKEN@github.com/chartjs/chartjs.github.io.git"
+VERSION_REGEX='[[:digit:]]+.[[:digit:]]+.[[:digit:]]+(-.*)?'
+
+# Make sure that this script is executed only for the release and master branches
+if [ "$TRAVIS_BRANCH" == "release" ]; then
+    # Travis executes this script from the repository root, so at the same level than package.json
+    VERSION=$(node -p -e "require('./package.json').version")
+elif [ "$TRAVIS_BRANCH" == "master" ]; then
+    VERSION="master"
+else
+    echo "Skipping deploy because this is not the master or release branch"
+    exit 0
+fi
+
+function update_latest {
+    local out_path=$1
+    local latest=($(ls -v $out_path | egrep '^('$VERSION_REGEX')$' | tail -1))
+    if [ "$latest" == "" ]; then latest='master'; fi
+    rm -f $out_path/latest
+    ln -s $latest $out_path/latest
+}
+
+function deploy_files {
+    local in_files=$1
+    local out_path=$2
+    rm -rf $out_path/$VERSION
+    mkdir -p $out_path/$VERSION
+    cp -r $in_files $out_path/$VERSION
+    update_latest $out_path
+}
+
+# Clone the repository and checkout the gh-pages branch
+git clone $TARGET_REPO_URL $TARGET_DIR
+cd $TARGET_DIR
+git checkout $TARGET_BRANCH
+
+# Copy dist files
+deploy_files '../dist/*.js' './dist'
+
+# Copy generated documentation
+deploy_files '../dist/docs/*' './docs'
+
+# Copy samples ...
+deploy_files '../samples/*' './samples'
+
+# ... and relocate samples Chart/js scripts
+for f in $(find ./samples/$VERSION -name '*.html'); do
+   sed -i -E "s/((\.\.\/)+dist\/)/..\/\1$VERSION\//" $f
+done
+
+git add -A
+
+git remote add auth-origin $TARGET_REPO_URL
+git config --global user.email "$GITHUB_AUTH_EMAIL"
+git config --global user.name "Chart.js"
+git commit -m "Deploy $VERSION from $TRAVIS_REPO_SLUG" -m "Commit: $TRAVIS_COMMIT"
+git push -q auth-origin $TARGET_BRANCH
+git remote rm auth-origin
+
+# Cleanup
+cd ..
+rm -rf $TARGET_DIR