ci_build.sh

#!/usr/bin/env bash

set -eo pipefail

setup_echo_colours() {
  # Exit the script on any error
  set -e

  # shellcheck disable=SC2034
  if [ "${MONOCHROME}" = true ]; then
    RED=''
    GREEN=''
    YELLOW=''
    BLUE=''
    BLUE2=''
    DGREY=''
    NC='' # No Colour
  else 
    RED='\033[1;31m'
    GREEN='\033[1;32m'
    YELLOW='\033[1;33m'
    BLUE='\033[1;34m'
    BLUE2='\033[1;34m'
    DGREY='\e[90m'
    NC='\033[0m' # No Colour
  fi
}

setup_ssh_agent() {
  # See if there is already a socket for ssh-agent
  if [[ -S "${SSH_AUTH_SOCK}" ]]; then
    echo -e "${GREEN}ssh-agent already bound to ${BLUE}SSH_AUTH_SOCK${NC}"
  else
    # Start ssh-agent and add our private ssh deploy key to it
    echo -e "${GREEN}Starting ssh-agent${NC}"
    ssh-agent -a "${SSH_AUTH_SOCK}" > /dev/null
  fi

  # SSH_DEPLOY_KEY is the private ssh key that corresponds to the public key
  # that is held in the 'deploy keys' section of the stroom repo on github
  # https://github.com/gchq/stroom/settings/keys
  echo -e "${GREEN}Adding ssh key${NC}"
  ssh-add - <<< "${SSH_DEPLOY_KEY}"
}

# Returns 0 if $1 is in the array of elements passed as subsequent args
# e.g. 
# arr=( "one" "two" "three" )
# element_in "two" "${arr[@]}" # returns 0
element_in() {
  local element 
  local match="$1"
  shift
  for element; do 
    [[ "${element}" == "${match}" ]] && return 0
  done
  return 1
}

build_version_from_source() {
  local branch_name="${1:-SNAPSHOT}"; shift
  local repo_root="$1"; shift
  local docs_root="${repo_root}/docs"

  pushd "${repo_root}"

  validate_source_schema
  # Run the gradle build to generate the different forms of the schema
  build_schema_variants
  
  #local hugo_base_url
  local generated_site_dir="${docs_root}/public"
  # The tag will be something like docs-v1234
  local pdf_filename="event-logging-schema-${BUILD_TAG:-docs-SNAPSHOT}_schema-${branch_name}.pdf"

  local branch_head_commit_sha
  branch_head_commit_sha="$(git rev-parse HEAD)"

  local branch_gh_pages_dir="${NEW_GH_PAGES_DIR}/${branch_name}"
  mkdir -p "${branch_gh_pages_dir}"

  # Write the commit sha to gh-pages so in future builds we can query it
  echo "${branch_head_commit_sha}" \
    > "${branch_gh_pages_dir}/${COMMIT_SHA_FILENAME}"

  echo -e "${GREEN}-----------------------------------------------------${NC}"
  echo -e "${GREEN}Building" \
    "\n  branch_name:            ${BLUE}${branch_name}${GREEN}" \
    "\n  branch_head_commit_sha: ${BLUE}${branch_head_commit_sha}${GREEN}" \
    "\n  repo_root:              ${BLUE}${repo_root}${GREEN}" \
    "\n  doc_root:               ${BLUE}${docs_root}${GREEN}" \
    "\n  latest_version:         ${BLUE}${latest_version}${GREEN}"
    #"\n  base_url:        ${BLUE}${hugo_base_url}${NC}"
  echo -e "${GREEN}-----------------------------------------------------${NC}"

  if [[ -n "${BUILD_TAG}" ]]; then
    local config_file="${docs_root}/${CONFIG_FILENAME}"
    echo -e "${GREEN}Updating config file ${BLUE}${config_file}${GREEN}" \
      "(build_version=${BUILD_TAG:-SNAPSHOT})${NC}"

    sed \
      --in-place'' \
      --regexp-extended \
      --expression "s/^  build_version *=.*/  build_version = \"${BUILD_TAG:-SNAPSHOT}\"/" \
      "${config_file}"
  fi

  # Don't want sections like news|community in the old versions
  if element_in "${branch_name}" "${release_branches[@]}" \
    && [[ "${branch_name}" != "${latest_version}" ]]; then
      remove_unwanted_sections "${docs_root}"
  fi

  # Build the Hugo site html (into ./docs/public/)
  # TODO, remove --buildDrafts arg once we merge to master
  echo "::group::Hugo build"
  echo -e "${GREEN}Building combined site HTML with Hugo${NC}"
  ./container_build/runInHugoDocker.sh build
  echo "::endgroup::"

  echo "::group::PDF generation"
  echo -e "${GREEN}Building whole site docs PDF for this branch${NC}"
  ./container_build/runInPupeteerDocker.sh PDF
  echo "::endgroup::"

  # Don't want to release anything for master
  if [[ "${branch_name}" != "master" ]]; then

    # Rename/move the generated PDF and also copy to gh-pages so we
    # can easily get it in a future build
    mv event-logging-schema-docs.pdf "${RELEASE_ARTEFACTS_DIR}/${pdf_filename}"
    #cp \
      #"${RELEASE_ARTEFACTS_DIR}/${pdf_filename}" \
      #"${branch_gh_pages_dir}/"

    # Might be some random feature branch
    if element_in "${branch_name}" "${release_branches[@]}"; then

      mkdir -p "${branch_gh_pages_dir}"
      echo -e "${GREEN}Copying site HTML (${BLUE}${generated_site_dir}${GREEN})" \
        "to combined gh-pages dir (${BLUE}${branch_gh_pages_dir}${GREEN})${NC}"
      cp -r "${generated_site_dir}"/* "${branch_gh_pages_dir}"

      # Now make a site that only knows about one version for inclusion with
      # stack/zip deployments. Must do this after the copy above as it will
      # modify the Hugo config
      make_single_version_site "${branch_name}" "${repo_root}"
    else
      echo -e "${BLUE}${branch_name}${GREEN} is not a release branch so won't" \
        "add it to ${BLUE}${NEW_GH_PAGES_DIR}${NC}"
    fi
  fi
  
  popd
}

copy_version_from_current() {
  local branch_name="${1:-SNAPSHOT}"; shift

  # If there have been no new commits on this branch then we can just copy
  # the site from the current gh-pages clone.
  echo -e "${GREEN}Copying current gh-pages site${NC}"
  cp -r "${CURRENT_GH_PAGES_DIR}/${branch_name}" "${NEW_GH_PAGES_DIR}/"

  # Now need to get the single site zip and pdf from github releases
  # to save us having to rebuild them

  echo -e "${GREEN}Dumping asset names for latest docs release" \
    "${BLUE}${LATEST_DOCS_RELEASE_TAG_NAME}${NC}"

  curl \
    --silent \
    --header "authorization: Bearer ${GITHUB_TOKEN}" \
    "${GIT_API_URL}/releases/tags/${LATEST_DOCS_RELEASE_TAG_NAME}" \
    | jq -r '.assets[] | .name'

  # Expecting stuff like
  #   event-logging-schema-docs-v123_schema-4.1.pdf
  #   event-logging-schema-docs-v123_schema-4.1.zip
  #   event-logging-schema-docs-v122_schema-4.0.pdf
  #   event-logging-schema-docs-v122_schema-4.0.zip

  # Double escape \. to \\\\., once for bash, once for jq
  local existing_zip_url=
  existing_zip_url="$( \
    curl \
      --silent \
      --header "authorization: Bearer ${GITHUB_TOKEN}" \
      "${GIT_API_URL}/releases/tags/${LATEST_DOCS_RELEASE_TAG_NAME}" \
      | jq -r ".assets[] | select(.name | test(\"^event-logging-schema-docs-.*_schema-${branch_name}\\\\.zip$\")) .browser_download_url")"

  echo -e "${GREEN}Downloading: ${BLUE}${existing_zip_url}${GREEN}" \
    "to ${BLUE}${RELEASE_ARTEFACTS_DIR}${NC}"

  wget \
    --quiet \
    --directory-prefix "${RELEASE_ARTEFACTS_DIR}" \
    "${existing_zip_url}"

  # Double escape \. to \\\\., once for bash, once for jq
  local existing_pdf_url=
  existing_pdf_url="$( \
    curl \
      --silent \
      --header "authorization: Bearer ${GITHUB_TOKEN}" \
      "${GIT_API_URL}/releases/latest" \
      | jq -r ".assets[] | select(.name | test(\"^event-logging-schema-docs-.*_schema-${branch_name}\\\\.pdf$\")) .browser_download_url")"

  echo -e "${GREEN}Downloading: ${BLUE}${existing_pdf_url}${GREEN}" \
    "to ${BLUE}${RELEASE_ARTEFACTS_DIR}${NC}"

  wget \
    --quiet \
    --directory-prefix "${RELEASE_ARTEFACTS_DIR}" \
    "${existing_pdf_url}"
}


assemble_version() {
  local branch_name="${1:-SNAPSHOT}"; shift

  # See if there have been any commits on this branch since the last
  # release.
  if has_release_branch_changed "${branch_name}"; then
    # Has new commits, so build the site and pdf from source for this version

    echo -e "${GREEN}Branch ${BLUE}${branch_name}${GREEN} has new commits" \
      "since last release${NC}"

    local branch_clone_dir="${GIT_WORK_DIR}/${branch_name}"

    echo "::group::Cloning branch ${branch_name}"
    echo -e "${GREEN}Cloning branch ${BLUE}${branch_name}${GREEN} of" \
      "${BLUE}${GIT_REPO_URL}${GREEN} into ${BLUE}${branch_clone_dir}${NC}"

    # Clone the required branch into a dir with the name of the branch
    git \
      clone \
      --depth 1 \
      --branch "${branch_name}" \
      --single-branch \
      "${GIT_REPO_URL}" \
      "${branch_clone_dir}"
    echo "::endgroup::"

    build_version_from_source "${branch_name}" "${branch_clone_dir}"
  else
    # No new commits so copy the existing site from gh-pages and the
    # pdf from gh releases
    echo -e "${GREEN}Branch ${BLUE}${branch_name}${GREEN} has not changed" \
      "since last release${NC}"
    copy_version_from_current "${branch_name}"
  fi
}

# We want a site for a single version that doesn't know about any of the
# others.
make_single_version_site() {
  local branch_name="${1:-SNAPSHOT}"; shift
  local repo_root="$1"; shift
  local docs_root="${repo_root}/docs"

  echo -e "${GREEN}Creating single version site for ${BLUE}${branch_name}" \
    "${repo_root}${NC}"

  local generated_site_dir="${docs_root}/public"
  local single_ver_zip_filename="${BUILD_NAME}_schema-${branch_name}.zip"

  local config_file="${docs_root}/${CONFIG_FILENAME}"
  local temp_config_backup_file
  temp_config_backup_file="$(mktemp)"
  cp "${config_file}" "${temp_config_backup_file}"

  # No point having the warning banner for it being an old version if it is
  # the only one
  echo -e "${GREEN}Updating config file ${BLUE}${config_file}${GREEN}" \
    "(archived_version=false)${NC}"
  sed \
    --in-place'' \
    --regexp-extended \
    --expression "s/^  archived_version = .*/  archived_version = false/" \
    "${config_file}"

  # This is a single version site so remove all the version blocks i.e.
  # everything inside these tags, including the tags
  #   <<<VERSIONS_BLOCK_START>>>
  #   ...
  #   <<<VERSIONS_BLOCK_END>>>
  # TODO This is a bit hacky so am open to ideas
  echo -e "${GREEN}Updating config file ${BLUE}${config_file}${GREEN}" \
    "(remove versions)${NC}"
  sed \
    --in-place'' \
    '/<<<VERSIONS_BLOCK_START>>>/,/<<<VERSIONS_BLOCK_END>>>/d' \
    "${config_file}"

  echo "::group::Diffing config changes"
  echo -e "${GREEN}Diffing config changes${NC}"
  echo -e "${GREEN}---------------------------------${NC}"
  diff "${temp_config_backup_file}" "${config_file}" \
    || true
  echo -e "${GREEN}---------------------------------${NC}"
  echo "::endgroup::"

  # Clear out the generated site dir from the last run
  rm -rf "${generated_site_dir:?}"/*

  # Don't want sections like news|community in the old versions
  if element_in "${branch_name}" "${release_branches[@]}" \
    && [[ "${branch_name}" != "${latest_version}" ]]; then
      remove_unwanted_sections "${docs_root}"
  fi

  # Now re-build the site with the modified config
  echo "::group::Hugo build"
  echo -e "${GREEN}Building single site HTML with Hugo${NC}"
  ./container_build/runInHugoDocker.sh build
  echo "::endgroup::"

  # go into the dir so all paths in the zip are relative to generated_site_dir
  pushd "${generated_site_dir}"

  echo -e "${GREEN}Creating single site zip" \
    "${BLUE}${single_ver_zip_filename}${NC}"
  zip \
    --recurse-paths \
    --quiet \
    -9 \
    "${RELEASE_ARTEFACTS_DIR}/${single_ver_zip_filename}" \
    ./*

  # Also copy the zip into gh-pages so it is easier for us to get on future
  # builds
  #cp \
    #"${RELEASE_ARTEFACTS_DIR}/${single_ver_zip_filename}" \
    #"${NEW_GH_PAGES_DIR}/${branch_name}/"

  popd
}

remove_unwanted_sections() {
  local site_root_dir="$1"; shift

  for section_name in "${UNWANTED_SECTIONS[@]}"; do
    local section_dir="${site_root_dir}/content/en/${section_name}"
    if [[ -d "${section_dir}" ]]; then
      echo -e "${GREEN}Removing section ${BLUE}${section_dir}${NC}"
      rm -rf "${section_dir:?}"
    else
      echo -e "${GREEN}Section ${BLUE}${section_dir}${GREEN} doesn't exist${NC}"
    fi
  done
}

create_root_redirect_page() {
  echo -e "${GREEN}Creating root redirect page with latest version" \
    "[${BLUE}${latest_version}${GREEN}]${NC}"

  # Create a symlink so we have something like
  # /
  #   /4.0/
  #   /4.1/
  #   /4.2/
  #   /latest/ -> /4.2/
  pushd "${NEW_GH_PAGES_DIR}"
  ln -s "./${latest_version}/" "latest" 
  popd

  # No make a redirect to the symlink so we open the latest
  # version by default
  sed \
    --regexp-extended \
    --expression "s/<<<LATEST_VERSION>>>/latest/g" \
    "${BUILD_DIR}/docs/index.html.template" \
    > "${NEW_GH_PAGES_DIR}/index.html"

  # This is to stop gh-pages treating the content as Jekyll content
  # in which case dirs prefixed with '_' are ignored breaking the print 
  # functionality
  touch "${NEW_GH_PAGES_DIR}/.nojekyll"
}

create_docs_release_tag() {
  setup_ssh_agent

  git config user.name "${GITHUB_ACTOR}"
  git config user.email "${GITHUB_ACTOR}@bots.github.com"

  pushd "${BUILD_DIR}"

  local tag_msg="Schema documentation v${BUILD_NUMBER}"
  tag_msg="${tag_msg}\n\nSchema versions:\n"

  for ver in "${release_branches[@]}"; do
    tag_msg="${tag_msg}\n * ${ver}"
  done

  # Tag the commit so we can create a release against it in github
  echo -e "Creating git tag ${GREEN}${BUILD_TAG}${NC}"
  git tag \
    "${BUILD_TAG}" \
    -a \
    -m "$( echo -e "${tag_msg}" )"

  echo -e "Pushing tag ${GREEN}${BUILD_TAG}${NC}"
  git push \
    -q \
    origin \
    "${BUILD_TAG}"
}

# Return: 0 if changed, 1 if not
has_release_branch_changed() {
  local branch_name="$1"; shift
  local repo_root="$1"; shift

  # Get the latest commit sha on this branch
  # DO NOT echo the token
  local latest_commit_sha=
  latest_commit_sha="$( \
    curl \
      --silent \
      --header "authorization: Bearer ${GITHUB_TOKEN}" \
      "${GIT_API_URL}/commits/${branch_name}" \
    | jq -r '.sha')"

  local gh_pages_commit_sha_file="${CURRENT_GH_PAGES_DIR}/${branch_name}/${COMMIT_SHA_FILENAME}"

  echo -e "${GREEN}gh_pages_commit_sha_file: ${BLUE}${gh_pages_commit_sha_file}${NC}"
  echo -e "${GREEN}branch_name: ${BLUE}${branch_name}${NC}"
  echo -e "${GREEN}latest_commit_sha: ${BLUE}${latest_commit_sha}${NC}"
  
  # When we build gh-pages from source we write the commit sha to a file
  # so we know which commit it came from
  if [[ -f "${gh_pages_commit_sha_file}" ]]; then
    local gh_pages_commit_sha
    gh_pages_commit_sha=$(<"${gh_pages_commit_sha_file}")
    echo -e "${GREEN}gh_pages_commit_sha: ${BLUE}${gh_pages_commit_sha}${NC}"

    if [[ "${gh_pages_commit_sha}" = "${latest_commit_sha}" ]]; then
      return 1
    else
      have_any_release_branches_changed=true
      return 0
    fi
  else
    # No commit sha file so treat as changed
    echo -e "${GREEN}Commit file ${BLUE}${gh_pages_commit_sha_file}${GREEN}" \
      "not found, treat as changed.${NC}"
    have_any_release_branches_changed=true
    return 0
  fi
}

clone_current_gh_pages_branch() {
  echo -e "${GREEN}Cloning gh-pages branch into" \
    "${BLUE}${CURRENT_GH_PAGES_DIR}${NC}"
  git \
    clone \
    --depth 1 \
    --branch "gh-pages" \
    --single-branch \
    "${GIT_REPO_URL}" \
    "${CURRENT_GH_PAGES_DIR}"
}

prepare_release_artefacts() {
  #echo -e "${GREEN}Copying from ${BLUE}${COMBINED_SITE_DIR}/${GREEN}" \
    #"to ${BLUE}${NEW_GH_PAGES_DIR}/${NC}"
  #cp -r "${COMBINED_SITE_DIR}"/* "${NEW_GH_PAGES_DIR}/"

  # Make sure master dir is not in the zipped site. It is ok to have it
  # in the gh-pages one so we can see docs for an as yet un-released
  # stroom, though master should not appear in the versions dropdown.
  rm -rf "${NEW_GH_PAGES_DIR}/master"

  echo -e "${GREEN}Dumping contents of ${BLUE}${NEW_GH_PAGES_DIR}${NC}"
  ls -1 "${NEW_GH_PAGES_DIR}/"

  echo -e "${GREEN}Making a zip of the combined site html content${NC}"

  # pushd so all paths in the zip are relative to this dir
  pushd "${NEW_GH_PAGES_DIR}"
  # Exclude the individual version zip/pdfs from the combined zip
  # Exclude arg needs to go after zip filename and target(s)
  # We have the 'latest' symlink so add that to the zip as a link
  # rather than dereferencing
  zip \
    --recurse-paths \
    --symlinks \
    --quiet \
    -9 \
    "${RELEASE_ARTEFACTS_DIR}/${ZIP_FILENAME}" \
    ./* \
    --exclude '*/event-logging-schema-docs-v*.zip' \
    --exclude '*/event-logging-schema-docs-v*.pdf'
  popd

  echo -e "${GREEN}Dumping contents of ${BLUE}${RELEASE_ARTEFACTS_DIR}${NC}"
  ls -1 "${RELEASE_ARTEFACTS_DIR}/"
}

prepare_for_schema_release() {
  echo -e "${GREEN}Preparing for a schema release${NC}"
  prepare_release_artefacts
}

prepare_for_docs_release() {
  echo -e "${GREEN}Preparing for a docs release${NC}"

  prepare_release_artefacts

  if [[ "${LOCAL_BUILD}" != "true" \
    && -n "$BUILD_TAG" \
    && "${BUILD_IS_PULL_REQUEST}" != "true" ]] ; then

    create_docs_release_tag
  else
    echo -e "${GREEN}Not a release so won't tag the repository${NC}"
  fi
}

populate_release_brances_arr() {
  echo -e "::group::Getting list of release branches"
  echo -e "${GREEN}Getting list of release branches${NC}"

  # Read all the matching release branches into the arr
  readarray -t release_branches \
    < <(curl \
      --silent \
      --header "authorization: Bearer ${GITHUB_TOKEN}" \
      "${GIT_API_URL}/branches" \
      | jq -r '.[] | select(.name | test("(^legacy|[0-9]+\\.[0-9]+$)")) | .name')

  echo -e "release_branches:      [${GREEN}${release_branches[*]}${NC}]"

  if [[ "${#release_branches[@]}" -eq 0 ]]; then
    echo "Error no release branches found. Dumping branches:"
    echo "---------"
    curl \
      --silent \
      --header "authorization: Bearer ${GITHUB_TOKEN}" \
      "${GIT_API_URL}/branches" \
      | jq -r '.[] | select(.name | test("(^legacy|[0-9]+\\.[0-9]+$)")) | .name'
    echo "---------"
    exit 1
  fi

  # print array, null delimited
  # Get just the 123.456 ones
  # Sort them by major then minor part
  # Get the biggest one
  latest_version="$( \
    printf '%s\n' "${release_branches[@]}" \
    | grep -E "^[0-9]+\.[0-9]+$" \
    | sort -t . -k 1,1n -k 2,2n \
    | tail -n1)"

  echo -e "latest_version:        [${GREEN}${latest_version}${NC}]"
  echo "::endgroup::"
}

validate_source_schema() {
  # validate the source schema - probably overkill as java will validate 
  # the generated schemas

  echo -e "::group::Validating source schema"
  xmllint \
    --noout \
    --schema http://www.w3.org/2001/XMLSchema.xsd \
    "${BUILD_DIR}/event-logging.xsd"
  echo "::endgroup::"
}

build_schema_variants() {
  echo -e "::group::Running gradle build"
  # run the gradle build to compile the transformations code and generate the 
  # schemas from the configured pipelines
  # The build will also validate the versions in the source schema
  # and validate the complete XML examples in the docs
  local gradle_args=()
  if [[ "${BUILD_IS_SCHEMA_RELEASE}" = "true" ]]; then
    gradle_args+=( "-Pversion=${SCHEMA_VERSION}" )
  fi

  echo -e "${GREEN}Gradle args [${BLUE}${gradle_args[*]}${GREEN}]${NC}"
    
  ./gradlew \
    --no-daemon \
    "${gradle_args[@]}" \
    clean \
    build \
    runShadow \
    -x diffAgainstLatest 

  ls -l ./event-logging-transformer-main/build/libs/

  ls -l ./event-logging-transformer-main/build/libs/event-logging-transformer*-all.jar

  if [[ "${BUILD_IS_SCHEMA_RELEASE}" = "true" ]]; then
    echo -e "${GREEN}Copying build artefacts for release${NC}"
    cp \
      "${BUILD_DIR}"/event-logging-transformer-main/build/libs/event-logging-transformer*-all.jar \
      "${RELEASE_ARTEFACTS_DIR}"
    cp \
      "${BUILD_DIR}"/event-logging-transformer-main/build/distributions/transformations-*.zip \
      "${RELEASE_ARTEFACTS_DIR}"

    GENERATED_DIR="event-logging-transformer-main/pipelines/generated"
    echo "Deleting generated schemas that are not release artifacts"
    # This is to make sure they don't get picked up for release
    rm -v "${GENERATED_DIR}"/event-logging-v999-documentation.xsd
    rm -v "${GENERATED_DIR}"/test-v*-test.xsd
    rm -v "${GENERATED_DIR}"/identity-v*-identity.xsd

    # Copy the schemas to the release dir for upload to gh releases
    cp "${GENERATED_DIR}"/*.xsd "${RELEASE_ARTEFACTS_DIR}/"
  fi
  echo "::endgroup::"
}

# All the documentation site versioning is based off the branch name
# so we need releases of the schema to be made on a release branch,
# e.g. tag v4.1.2 on branch 4.1.
check_branch_of_tag() {
  echo -e "::group::Checking which branches the tag is on"
  if [[ "${BUILD_IS_SCHEMA_RELEASE}" = "true" ]]; then
    echo -e "${GREEN}Checking tag is on a release branch${NC}"

    # The repo already checked out is in a detached head state
    # so we cannot use it to determine which branches our tag is on,
    # thus clone a full one.
    local fresh_clone_dir="${BUILD_DIR}/_fresh_git_clone"
    git clone \
      https://github.com/gchq/event-logging-schema.git \
      "${fresh_clone_dir}"
    pushd "${fresh_clone_dir}"

    # Make sure the git tag exists on a release branch, else
    # no docs will be created for it
    # Branch may look like:
    # 4.0
    # remotes/origin/4.0
    local release_branch_pattern="^(remotes/[^/]+/)?[0-9]+\.[0-9]+$"
    local release_branches_for_tag=
    # OR with echo to stop pipefail killing the script
    release_branches_for_tag="$( \
      { git \
          --no-pager \
          branch \
          --all \
          --contains \
          "tags/${BUILD_TAG}" \
        || echo "" ; } \
        | sed 's/..//' \
        | grep -E "${release_branch_pattern}"
      )"

    if [[ -z "${release_branches_for_tag}" ]]; then
      echo "${RED}Error${NC}Release tag ${BUILD_TAG} not found on a" \
        "release branch (pattern ${release_branch_pattern})."
      echo "Dumping branches containing ${BUILD_TAG}:"
      { git \
          --no-pager \
          branch \
          --all \
          --contains \
          "tags/${BUILD_TAG}" \
        || echo "" ; } \
        | sed 's/..//'
      exit 1
    fi
    popd
  else
    echo -e "${GREEN}Not a schema release so no branch check needed.${NC}"
  fi
  echo "::endgroup::"
}

dump_build_info() {
  echo "::group::Build info"

  #Dump all the env vars to the console for debugging
  echo -e "PWD:                          [${GREEN}$(pwd)${NC}]"
  echo -e "BUILD_DIR:                    [${GREEN}${BUILD_DIR}${NC}]"
  echo -e "BUILD_NUMBER:                 [${GREEN}${BUILD_NUMBER}${NC}]"
  echo -e "BUILD_COMMIT:                 [${GREEN}${BUILD_COMMIT}${NC}]"
  echo -e "BUILD_BRANCH:                 [${GREEN}${BUILD_BRANCH}${NC}]"
  echo -e "BUILD_TAG:                    [${GREEN}${BUILD_TAG}${NC}]"
  echo -e "BUILD_IS_PULL_REQUEST:        [${GREEN}${BUILD_IS_PULL_REQUEST}${NC}]"
  echo -e "BUILD_IS_SCHEMA_RELEASE:      [${GREEN}${BUILD_IS_SCHEMA_RELEASE}${NC}]"
  echo -e "BUILD_IS_DOCS_RELEASE:        [${GREEN}${BUILD_IS_DOCS_RELEASE}${NC}]"
  echo -e "BUILD_IS_FORCED_DOCS_RELEASE: [${GREEN}${BUILD_IS_FORCED_DOCS_RELEASE}${NC}]"
  echo -e "LATEST_DOCS_RELEASE_TAG_NAME: [${GREEN}${LATEST_DOCS_RELEASE_TAG_NAME}${NC}]"
  echo -e "RELEASE_ARTEFACTS_DIR:        [${GREEN}${RELEASE_ARTEFACTS_DIR}${NC}]"
  echo -e "SCHEMA_VERSION:               [${GREEN}${SCHEMA_VERSION}${NC}]"
  echo -e "PDF_FILENAME:                 [${GREEN}${PDF_FILENAME}${NC}]"
  echo -e "ZIP_FILENAME:                 [${GREEN}${ZIP_FILENAME}${NC}]"
  echo -e "UNWANTED_SECTIONS:            [${GREEN}${UNWANTED_SECTIONS[*]}${NC}]"

  echo "::endgroup::"
}

create_dir() {
  local dir="${1:?dir not set}"; shift
  echo -e "${GREEN}Creating directory ${BLUE}${dir}${NC}"
  mkdir -p "${dir}"
}

main() {
  if [ -n "$BUILD_TAG" ]; then
      #Tagged commit so use that as our stroom version, e.g. v3.0.0
      SCHEMA_VERSION="${BUILD_TAG}"
      DOCS_VERSION="${BUILD_TAG}"
  else
      DOCS_VERSION="docs-SNAPSHOT"
  fi

  local BUILD_NAME="event-logging-schema-${DOCS_VERSION}"
  local PDF_FILENAME=${BUILD_NAME}.pdf
  local ZIP_FILENAME=${BUILD_NAME}.zip
  local RELEASE_ARTEFACTS_DIR_NAME="release_artefacts"
  local RELEASE_ARTEFACTS_DIR="${BUILD_DIR}/${RELEASE_ARTEFACTS_DIR_NAME}"
  #RELEASE_ARTEFACTS_REL_DIR="./${RELEASE_ARTEFACTS_DIR_NAME}"
  local SINGLE_SITE_DIR="${BUILD_DIR}/_single_site"
  local GIT_WORK_DIR="${BUILD_DIR}/_git_work"
  local NEW_GH_PAGES_DIR="${BUILD_DIR}/gh-pages"
  local CURRENT_GH_PAGES_DIR="${BUILD_DIR}/gh-pages_current"
  local GIT_REPO_URL="https://github.com/gchq/event-logging-schema.git"
  local GIT_API_URL="https://api.github.com/repos/gchq/event-logging-schema"
  local CONFIG_FILENAME="config.toml"
  local COMMIT_SHA_FILENAME="commit.sha1"
  local have_any_release_branches_changed=false
  # These are the sections we don't want in old/single versions of the site
  # Can't remove community at the mo as some pages in docs link to it
  local UNWANTED_SECTIONS=(
    #"community"
    "news"
  )

  dump_build_info
  check_branch_of_tag

  echo "::group::Create dirs"
  create_dir "${RELEASE_ARTEFACTS_DIR}"
  create_dir "${GIT_WORK_DIR}"
  create_dir "${NEW_GH_PAGES_DIR}"
  create_dir "${SINGLE_SITE_DIR}"
  echo "::endgroup::"

  # Both of these get set by the call to populate_release_brances_arr()
  local release_branches=()
  local latest_version=
  populate_release_brances_arr

  clone_current_gh_pages_branch

  # If this is a scheduled build there is point in building the master branch
  # as it will have been built before and is not part of the release.
  if [[ ! "${GITHUB_EVENT_NAME}" = "schedule" ]]; then
    # Build the commit/tag/pr that triggered this script to run
    # to ensure the site and PDF build ok. E.g. this might be some feature
    # branch
    build_version_from_source "${BUILD_BRANCH}" "${BUILD_DIR}"
  fi

  pushd "${GIT_WORK_DIR}"

  # Now build each of the release branches (if they have changed)
  for branch_name in "${release_branches[@]}"; do

    if [[ "${branch_name}" = "3.5" ]]; then
      # 3.5 is not set up with the hugo docs site so skip it
      break
    fi

    if ! git ls-remote --exit-code --heads origin "refs/heads/${branch_name}"; then
      echo -e "${RED}ERROR: Branch ${BLUE}${branch_name}${RED}" \
        "does not exist. Check contents of release_branches array.${NC}"
      exit 1
    fi

    # Don't build the branch that we built above
    if [[ "${branch_name}" != "${BUILD_BRANCH}" ]]; then

      # Run the build for this branch in the self named dir
      assemble_version "${branch_name}" "${branch_clone_dir}"
    else
      echo -e "${GREEN}Skipping build for ${BLUE}${branch_name}${NC}"
    fi
  done

  popd

  # In the absence of url rewriting on github pages create an index.html
  # that does a redirect to the latest version e.g. / => /7.1
  create_root_redirect_page

  echo -e "${GREEN}have_any_release_branches_changed:" \
    "${BLUE}${have_any_release_branches_changed}${NC}"

  if [[ "${BUILD_IS_SCHEMA_RELEASE}" = "true" ]]; then
    prepare_for_schema_release
    echo "DOCS_CONTENT_HAS_CHANGED=false" >> "${GITHUB_ENV}"
  elif [[ "${BUILD_IS_DOCS_RELEASE}" = "true" ]]; then
    if [[ "${have_any_release_branches_changed}" = "true" ]]; then
      prepare_for_docs_release
      echo "DOCS_CONTENT_HAS_CHANGED=true" >> "${GITHUB_ENV}"
    else
      echo -e "${GREEN}Nothing has changed since last release so skipping" \
        "release preparation${NC}"
      # Clear out any artefacts to be on the safe side
      rm -rf "${RELEASE_ARTEFACTS_DIR:?}/*"
      rm -rf "${NEW_GH_PAGES_DIR:?}/*"
      echo "DOCS_CONTENT_HAS_CHANGED=false" >> "${GITHUB_ENV}"
    fi
  else
    echo -e "${GREEN}Not a release so skipping releaase preparation${NC}"
    # Clear out any artefacts to be on the safe side
    rm -rf "${RELEASE_ARTEFACTS_DIR:?}/*"
    rm -rf "${NEW_GH_PAGES_DIR:?}/*"

    echo "DOCS_CONTENT_HAS_CHANGED=false" >> "${GITHUB_ENV}"
  fi
}

main "$@"