Migrate to GitHub Actions

Better release workflow which doesn't rely anymore on a release branch
but instead must be manually triggered from the GH Actions panel for a
specific branch. A tag is automatically created for the version in the
"package.json" file and will be pushed with dist files. Assets (*.zip,
*.tgz, dist/*.js) are attached to the release notes, which must exist
in a "draft" state for the release workflow to success.

Publishing to npm now happens when a GH release is published, which is
not anymore automatic when the Git tag is created. This allows a final
review of the release notes, tag and assets. When publishing to npm, a
tag is calculated based on existing npm tags and can be either "next",
"dev", "latest" or "untagged". See "scripts/utils.js" for details.

Finally, rewrite all scripts to JavaScript (no more bash scripts).

Author: simonbrunel

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+# https://docs.github.com/actions/reference/workflow-syntax-for-github-actions
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: npm ci
+      - run: npm run build
+      - run: npm run lint
+      - run: npm run test
+      - uses: actions/upload-artifact@v2
+        with:
+          path: dist/
+          name: chartjs-plugin-deferred
+          if-no-files-found: error

.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+# https://docs.github.com/actions/reference/workflow-syntax-for-github-actions
+
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-to-npm:
+    if: github.repository_owner == 'chartjs'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: node scripts/publish-to-npm.js
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+# https://docs.github.com/actions/reference/workflow-syntax-for-github-actions
+
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: npm ci
+      - run: npm run build
+      - run: npm run bower
+      - run: npm run package
+      - run: node scripts/attach-gh-assets.js
+        env:
+          # https://github.com/cli/cli/discussions/3029
+          GITHUB_TOKEN: ${{ secrets.GH_AUTH_TOKEN }}
+          DEBUG: api
+      - run: node scripts/create-release-tag.js
+        env:
+          GH_AUTH_EMAIL: ${{ secrets.GH_AUTH_EMAIL }}
+          GH_AUTH_NAME: ${{ secrets.GH_AUTH_NAME }}

.travis.yml

@@ -0,0 +1,35 @@
+// https://hub.github.com/hub-release.1.html
+// https://cli.github.com/manual/
+/* eslint-disable no-process-exit */
+
+const {run} = require('./utils');
+const pkg = require('../package.json');
+
+const TAG = `v${pkg.version}`;
+
+const ASSETS = [
+  `dist/${pkg.name}.js`,
+  `dist/${pkg.name}.min.js`,
+  `dist/${pkg.name}.esm.js`,
+  `dist/${pkg.name}.tgz`,
+  `dist/${pkg.name}.zip`,
+];
+
+(async() => {
+  if (!process.env.GITHUB_TOKEN) {
+    throw new Error('GITHUB_TOKEN environment variable required');
+  }
+  if ((await run(`hub release show ${TAG} -f "%T: %S"`)) !== `${TAG}: draft`) {
+    throw new Error(`Release ${TAG} has already been published.`);
+  }
+
+  // Attach assets to the associated GitHub release.
+  // Note that the `hub release edit -a ${ASSETS.join(' -a ')} -m "" "${TAG}"`
+  // command does not allow to overwrite existing assets, so use 'gh' instead.
+  // See https://github.com/github/hub/issues/2657
+  await run(`gh release upload ${TAG} ${ASSETS.join(' ')} --clobber`);
+
+})().catch((error) => {
+  console.error(`Failed to publish to github: ${error.message || error}.`);
+  process.exit(1);
+});

scripts/attach-gh-assets.js

@@ -0,0 +1,37 @@
+/* eslint-disable no-process-exit */
+
+const {run} = require('./utils');
+const pkg = require('../package.json');
+
+const TAG = `v${pkg.version}`;
+const TAG_FILES = [
+  `dist/${pkg.name}.js`,
+  `dist/${pkg.name}.min.js`,
+  `dist/${pkg.name}.esm.js`,
+  'bower.json',
+];
+
+(async() => {
+  if (!process.env.GH_AUTH_EMAIL) {
+    throw new Error('GH_AUTH_EMAIL environment variable required');
+  }
+  if (!process.env.GH_AUTH_NAME) {
+    throw new Error('GH_AUTH_NAME environment variable required');
+  }
+  if (await run(`git ls-remote origin refs/tags/${TAG}`)) {
+    throw new Error(`Git tag ${TAG} already exists`);
+  }
+
+  // Tag a detached branch containing the dist (and bower) files.
+  await run(`git config --global user.email "${process.env.GH_AUTH_EMAIL}"`);
+  await run(`git config --global user.name "${process.env.GH_AUTH_NAME}"`);
+  await run('git checkout --detach --quiet');
+  await run(`git add -f ${TAG_FILES.join(' ')}`);
+  await run(`git commit -m "Release ${TAG}"`);
+  await run(`git tag -a "${TAG}" -m "Version ${pkg.version}"`);
+  await run(`git push origin refs/tags/${TAG}`);
+
+})().catch((error) => {
+  console.error(`Failed to create release tag: ${error.message || error}.`);
+  process.exit(1);
+});

scripts/create-release-tag.js

@@ -0,0 +1,23 @@
+/* eslint-disable no-process-exit */
+/* eslint-disable no-console */
+
+const {run, semtag} = require('./utils');
+const {version} = require('../package.json');
+
+(async() => {
+  const tags = (await run('npm dist-tag ls')).split('\n').reduce((acc, line) => {
+    const matches = (/^([^:]+): (.+)$/).exec(line);
+    acc[matches[1]] = matches[2];
+    return acc;
+  }, {});
+
+  const tag = semtag(tags, version);
+
+  console.info(`Publishing version ${version} (@${tag})`);
+
+  await run(`npm publish --tag ${tag}`);
+
+})().catch((error) => {
+  console.error(`Failed to publish to npm: ${error.message || error}.`);
+  process.exit(1);
+});

scripts/publish-to-npm.js

@@ -0,0 +1,41 @@
+const {exec} = require('child_process');
+const semver = require('semver');
+
+module.exports = {
+  run: (cmd) => new Promise((resolve, reject) => {
+    exec(cmd, {}, (error, stdout, stderr) => {
+      if (error) {
+        reject(stderr.trim());
+      } else {
+        resolve(stdout.trim());
+      }
+    });
+  }),
+
+  /**
+   * Returns, based on existing npm `tags`, the tag under which to publish the given `version`.
+   */
+  semtag: (tags, version) => {
+    const {latest} = tags;
+
+    // Versions prior to 'latest' are marked 'untagged'.
+    if (latest && semver.gte(latest, version)) {
+      return 'untagged';
+    }
+
+    // Full versions greater than 'latest' become the new 'latest'.
+    if (!semver.prerelease(version)) {
+      return 'latest';
+    }
+
+    // Pre-versions for the same 'latest' major version are tagged 'dev', else are
+    // tagged 'next' for a greater major version. However, if the tag already exists
+    // with a greater version, the version to publish is marked 'untagged'.
+    const tag = latest && semver.major(latest) < semver.major(version) ? 'next' : 'dev';
+    if (tags[tag] && semver.lte(version, tags[tag])) {
+      return 'untagged';
+    }
+
+    return tag;
+  }
+};