VERSIONS.env

#!/bin/bash
# (shebang not really needed, but required by ShellCheck)
# File checked with ShellCheck (https://www.shellcheck.net/)

# This file should be sourced by "configure.sh".
#
# PROJECT_VERSIONS is a Bash Associative Array. It contains all placeholder
# names and their values, that get replaced in the documentation sources.
#
# Normally, KMS is updated faster than other modules, so it is common that
# e.g. VERSION_KMS is "6.12.1" while most other modules still are at "6.12.0".

# shellcheck disable=SC2034
declare -A PROJECT_VERSIONS=(
    # Version of the documentation itself; it appears in the main menu
    [VERSION_DOC]="6.18.0"

    # Version of Kurento Media Server
    [VERSION_KMS]="6.18.0"

    # Version of each Client API SDK
    [VERSION_CLIENT_JAVA]="6.18.0"
    [VERSION_CLIENT_JS]="6.18.0"

    # Version of the JavaScript utils module (kurento-utils-js)
    [VERSION_UTILS_JS]="6.18.0"

    # Version of each platform's tutorials
    [VERSION_TUTORIAL_JAVA]="6.18.0"
    [VERSION_TUTORIAL_JS]="6.18.0"
    [VERSION_TUTORIAL_NODE]="6.18.0"

    # Indicates if the current state of this code is Release or Nightly.
    # If "true", all mentioned repos will be checked out to the corresponding
    # versions; otherwise, they will be kept at the default branch (master).
    [VERSION_RELEASE]="true"
)

# If the build is not for a release, then some versions can be set to more
# adequate values for each case:
if [[ "${PROJECT_VERSIONS[VERSION_RELEASE]}" != "true" ]]; then
    # VERSION_TUTORIAL_{JAVA,JS,NODE} are used in tutorial texts to instruct the
    # user about running `git checkout <Version>`, so making it "master" will
    # keep them at the development versions on non-release builds of the docs.
    PROJECT_VERSIONS[VERSION_TUTORIAL_JAVA]="master"
    PROJECT_VERSIONS[VERSION_TUTORIAL_JS]="master"
    PROJECT_VERSIONS[VERSION_TUTORIAL_NODE]="master"
fi