From 31bfcdc0f11f360657cba61586e9d8978b6ac7d4 Mon Sep 17 00:00:00 2001
From: Pixelastic <tim@pixelastic.com>
Date: Thu, 4 Oct 2018 17:58:45 +0200
Subject: [PATCH] Adding deploy previews on any changes in the docs

---
 docs/README.md                      | 19 +++++++++++++++++++
 docs/scripts/netlify-deploy-preview | 18 ++++++++++++++++++
 netlify.toml                        |  2 +-
 3 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100755 docs/scripts/netlify-deploy-preview

diff --git a/docs/README.md b/docs/README.md
index f1797cb6..cba5898d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -36,6 +36,25 @@ any changes were made in the `./docs` subfolder. If no changes were made, it
 will finish, otherwise it will build the website and push it to
 `gh-pages`.
 
+### Deploy previews
+
+Any new Pull Request to the documentation will trigger a deploy preview build.
+
+Netlify is configured to run `./scripts/netlify-deploy-preview` on each new PR
+(check `netlify.toml` for details).
+
+This script will first check if changes were made to the `./docs` subfolder in
+the PR. If no change were made, the preview will not be generated (this will
+make processing time faster).
+
+Whenever the preview is ready, a message from Algobot will be added to the PR,
+along with the link to the preview. This is configured in Netlify UI in _Build
+and Deploy > Deploy notifications > Comment on GitHub pull request when deploy
+succeeds_. It uses a GitHub token from Algobot to post on its behalf. To
+generate such a token, login to Netlify with Algobot and pretend to create such
+a notification on any project, generate a token, and then copy-paste it in the
+real DocSearch account in Netlify.
+
 ## Internals
 
 The documentation generation is not using any existing static websites
diff --git a/docs/scripts/netlify-deploy-preview b/docs/scripts/netlify-deploy-preview
new file mode 100755
index 00000000..49e405f0
--- /dev/null
+++ b/docs/scripts/netlify-deploy-preview
@@ -0,0 +1,18 @@
+#!/usr/bin/env sh
+# This script is triggered on every new PR (see netlify.toml for details)
+# It will create a live preview of the PR
+set -e
+
+# Environment variables exposed by Netlify:
+# https://www.netlify.com/docs/continuous-deployment/#build-environment-variables
+# $REPOSITORY_URL, $BRANCH, $PULL_REQUEST, $HEAD, $COMMIT_REF, $CONTEXT,
+# $REVIEW_ID
+
+# We build a very simple preview if no change were made to the docs
+cd ./docs
+if ! git diff --name-status master | grep 'docs/' 1>/dev/null; then
+  mkdir -p ./dist
+  echo "No deploy preview available as this PR does not change the documentation." > ./dist/index.html
+else
+  yarn run build
+fi
diff --git a/netlify.toml b/netlify.toml
index ba16b1ee..5ba4d86e 100644
--- a/netlify.toml
+++ b/netlify.toml
@@ -11,5 +11,5 @@
 
 # Deploy previews on each PR
 [context.deploy-preview]
-  command = "yarn run docs:build"
+  command = "./docs/scripts/netlify-deploy-preview"
   publish = "docs/dist"