docs/build_docs.sh

#!/usr/bin/env bash
################################################################################
#  Licensed to the Apache Software Foundation (ASF) under one
#  or more contributor license agreements.  See the NOTICE file
#  distributed with this work for additional information
#  regarding copyright ownership.  The ASF licenses this file
#  to you under the Apache License, Version 2.0 (the
#  "License"); you may not use this file except in compliance
#  with the License.  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
# limitations under the License.
################################################################################

RUBY=${RUBY:-ruby}
GEM=${GEM:-gem}
CACHE_DIR=${CACHE_DIR:-".rubydeps"}

set -e
cd "$(dirname ${BASH_SOURCE[0]})"

DIR="`pwd`"

# We need at least bundler to proceed
if [ "`command -v bundle`" == "" ]; then
	RUBYGEM_BINDIR=""

	# Adjust the PATH to discover locally installed ruby gem binaries
	export PATH="$(${RUBY} -e 'puts Gem.user_dir')/bin:$PATH"

	if [ "`command -v bundle`" == "" ]; then
		echo "WARN: Could not find bundle."
		echo "Attempting to install locally. If this doesn't work, please install with 'gem install bundler'."

		# install bundler locally
		${GEM} install --user-install --no-format-executable bundler
	fi
fi

# Install Ruby dependencies locally
bundle install --path ${CACHE_DIR}

DOCS_SRC=${DIR}
DOCS_DST=${DOCS_SRC}/content

# default jekyll command is to just build site
JEKYLL_CMD="build"

JEKYLL_CONFIG=""

DOC_LANGUAGES="en zh"

# if -p flag is provided, serve site on localhost
# -i is like -p, but incremental (only rebuilds the modified file)
# -e builds only english documentation
# -z builds only chinese documentation 
while getopts "piez" opt; do
	case $opt in
		p)
		JEKYLL_CMD="serve --baseurl= --watch"
		;;
		i)
		[[ `${RUBY} -v` =~ 'ruby 1' ]] && echo "Error: building the docs with the incremental option requires at least ruby 2.0" && exit 1
		JEKYLL_CMD="serve --baseurl= --watch --incremental"
		;;
		e)
		JEKYLL_CONFIG="--config _config.yml,_config_dev_en.yml"
		;;
		z)
		JEKYLL_CONFIG="--config _config.yml,_config_dev_zh.yml"
		;;
		*) echo "usage: $0 [-e|-z] [-i|-p]" >&2
		exit 1 ;;
	esac
done

# use 'bundle exec' to insert the local Ruby dependencies

if [ "${JEKYLL_CMD}" = "build" ] && [ -z "${JEKYLL_CONFIG}" ]; then
  # run parallel builds for all languages if not serving or creating a single language only

  # run processes and store pids
  echo "Spawning parallel builds for languages: ${DOC_LANGUAGES}..."
  pids=""
  for lang in ${DOC_LANGUAGES}; do
    bundle exec jekyll ${JEKYLL_CMD} --config _config.yml,_config_dev_${lang}.yml --source "${DOCS_SRC}" --destination "${DOCS_DST}_${lang}" &
    pid=$!
    pids="${pids} ${pid}"
  done

  # wait for all pids (since jekyll returns 0 even in case of failures, we do not parse exit codes)
  wait ${pids}
  rm -rf "${DOCS_DST}"
  mkdir -p "${DOCS_DST}"
  for lang in ${DOC_LANGUAGES}; do
    cp -aln "${DOCS_DST}_${lang}/." "${DOCS_DST}"
    rm -rf "${DOCS_DST}_${lang}"
  done
  exit 0
else
  bundle exec jekyll ${JEKYLL_CMD} ${JEKYLL_CONFIG} --source "${DOCS_SRC}" --destination "${DOCS_DST}"
fi