test new script

[jonathanl-telenav]

I cannot push my changes because of the earlier problem with .gitmodules, but here are the scripts. When the other bugs are resolved, give it a try. Should be very close to working now.

[jonathanl-telenav]

release.sh

#!/bin/bash

##############################################################################
# Settings
##############################################################################

# Version of the Cactus Maven plugin to use
export CACTUS_PLUGIN_VERSION=1.5.8

# Set this to whatever profile makes the right GPG keys available, from your ~/.m2/settings.xml
export GPG_PROFILE=gpg

# This should be 'release' when really releasing or something else when testing
export RELEASE_BRANCH_PREFIX=release

##############################################################################
# Determine project families to release
##############################################################################

echo " "
echo "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ Cactus ${CACTUS_PLUGIN_VERSION}"
echo "┋"

read -r -p "┋ What project families do you want to release [kivakit,lexakai,mesakit]? "
if [[ -z "${REPLY}" ]]; then
    export PROJECT_FAMILIES='kivakit,lexakai,mesakit'
else
    export PROJECT_FAMILIES=$REPLY
fi

##############################################################################
# Locate the workspace we're releasing based on this script's path
##############################################################################

# shellcheck disable=SC2164
WORKSPACE="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"

echo "┋"
echo "┋ Release project families: ${PROJECT_FAMILIES}"
echo "┋ Release workspace: ${WORKSPACE}"
echo "┋ Release branch prefix: ${RELEASE_BRANCH_PREFIX}"

cd "${WORKSPACE}" || exit 1

##############################################################################
# RELEASE PHASE 0 - Check the workspace to make sure it is ready to be
# released, then clone the develop branch into a temporary workspace,
# whose location we parse from the output of the plugin.
##############################################################################

echo "┋ "
echo "┋━━━━━━━ PHASE 0 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "Cloning develop branch for release... (this may take a while)"

output=$(mvn \
    -P release-phase-0 \
    -Dcactus.maven.plugin.version="${CACTUS_PLUGIN_VERSION}" \
    -Dcactus.families="${PROJECT_FAMILIES}" \
        validate)

root=$(echo "$output" | grep "checkout-root: ")

if [[ ! $root == *"checkout-root: "* ]]; then
    echo "$output"
    echo " "
    echo "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ ERROR!"
    echo "┋ "
    echo "┋ PHASE 0 - Release checkout failed. Please check your workspace."
    echo "┋ All projects should be on their 'develop' branches with no modified files."
    echo "┋"
    echo "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
    echo " "
    exit 1
fi

TEMPORARY_WORKSPACE=${root#*checkout-root: }

echo "┋ Temporary workspace: ${TEMPORARY_WORKSPACE}"

##############################################################################
# Create temporary maven repository to ensure a clean build
##############################################################################

export MAVEN_REPOSITORY="${TEMPORARY_WORKSPACE}"/maven-repository
rm -rf "${MAVEN_REPOSITORY}" 1> /dev/null

echo "┋ Maven repository: ${MAVEN_REPOSITORY}"

##############################################################################
# Define Maven JVM options. The system property cactus.release.branch.prefix
# lets us create test release branches without stepping the real release.
##############################################################################

export MAVEN_OPTS="-XX:+UseG1GC \
    -Dcactus.debug=false \
    -DreleasePush=true \
    -Dmaven.repo.local=\"${MAVEN_REPOSITORY}\" \
    --add-opens=java.base/java.util=ALL-UNNAMED \
    --add-opens=java.base/java.lang.reflect=ALL-UNNAMED \
    --add-opens=java.base/java.text=ALL-UNNAMED \
    --add-opens=java.desktop/java.awt.font=ALL-UNNAMED \
    -Dcactus.release.branch.prefix=\"${RELEASE_BRANCH_PREFIX}\""

##############################################################################
# Check installed tools and clean out project caches
##############################################################################

source "${WORKSPACE}"/bin/telenav-library-functions.sh

echo "┋ Checking tools"
check_tools
echo "┋ Cleaning project caches"
clean_caches

##############################################################################
# Install superpoms and build the workspace without tests enabled
##############################################################################

echo "┋ Installing superpoms"
mvn --quiet -f telenav-superpom/pom.xml install | exit 1

echo "┋ Checking build (no tests)"
mvn --quiet -Dmaven.test.skip=true clean install | exit 1

echo "┋━━━━━━━ PHASE 0 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"

##############################################################################
# RELEASE PHASE 1 - Update versions and branch references
##############################################################################

echo "┋ "
echo "┋━━━━━━━ PHASE 1 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "┋ Updating versions and branch references"

mvn --quiet \
    -P release-phase-1 \
    -Denforcer.skip=true \
    -Dcactus.expected.branch=develop \
    -Dcactus.maven.plugin.version="${CACTUS_PLUGIN_VERSION}" \
    -Dcactus.families="${PROJECT_FAMILIES}" \
    -Dcactus.release.branch.prefix="${RELEASE_BRANCH_PREFIX}" \
    -Dmaven.test.skip=true \
        clean validate | exit 1

##############################################################################
# Rebuild everything with tests now that some things have new versions
##############################################################################

echo "┋ Installing superpoms"
mvn -f telenav-superpom/pom.xml install | exit 1

echo "┋ Checking build (tests enabled)"
mvn clean install | exit 1

echo "┋━━━━━━━ PHASE 1 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"

##############################################################################
# RELEASE PHASE 2 - Build documentation
##############################################################################

echo "┋ "
echo "┋━━━━━━━ PHASE 2 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "┋ Building documentation"

mvn -P release-phase-2 \
    --quiet \
    -Dcactus.maven.plugin.version="${CACTUS_PLUGIN_VERSION}" \
    -Dcactus.families="${PROJECT_FAMILIES}" \
    -Dcactus.release.branch.prefix="${RELEASE_BRANCH_PREFIX}" \
    -Dmaven.test.skip=true \
        clean \
        install \
        org.apache.maven.plugins:maven-site-plugin:4.0.0-M1:site verify | exit 1

echo "┗━━━━━━━ PHASE 2 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"

##############################################################################
# Review the release
##############################################################################

echo " "
echo "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ Review ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "┋"
echo "┋ Release is ready for you to review now:"
echo "┋"
echo "┋    1. Check the documentation, including links and diagrams"
echo "┋    2. Check that version numbers and branch names were updated correctly"
echo "┋"
echo "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
echo " "

while
    ask "When ready to continue, type 'release': "
    [[ "${REPLY}" == "release" ]]
do true; done

##############################################################################
# RELEASE PHASE 3 - Commit documentation changes, build the release and
# publish to Nexus / OSSRH (https://s01.oss.sonatype.org/)
##############################################################################

echo "┏━━━━━━━ PHASE 3 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "┋ Publishing release..."

mvn -P release-phase-3 \
    -Dcactus.maven.plugin.version="${CACTUS_PLUGIN_VERSION}" \
    -P ${GPG_PROFILE} \
    -Dcactus.families="${PROJECT_FAMILIES}" \
    -Dcactus.release.branch.prefix="${RELEASE_BRANCH_PREFIX}" \
    -Dmaven.test.skip=true \
        deploy | exit 1

echo "┗━━━━━━━ PHASE 3 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"

##############################################################################
# RELEASE PHASE 4 - Merge changes back to develop and release/current and
# update the develop branch to the next snapshot version
##############################################################################

echo "┏━━━━━━━ PHASE 4 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
echo "┋ Merging release and updating to next snapshot version..."

mvn -P release-phase-4 \
    -Dcactus.maven.plugin.version="${CACTUS_PLUGIN_VERSION}" \
    -Dcactus.families="${PROJECT_FAMILIES}" \
    -Dmaven.test.skip=true \
    generate-resources | exit 1

echo "┗━━━━━━━ PHASE 4 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"

##############################################################################
# END
##############################################################################

echo "┋"
echo "┋ Release of ${PROJECT_FAMILIES} complete!"
echo "┋"
echo "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"

[jonathanl-telenav]

telenav-library-functions.sh

################ VARIABLES ################################################################################################

export NORMAL='\033[0m'
export ATTENTION='\033[1;32m'

if [[ "$OSTYPE" == "darwin"* ]]; then

    export HISTCONTROL=ignoreboth:erasedups

fi

################ BUILD ##################################################################################################

cd_workspace()
{
    if [[ "$TELENAV_WORKSPACE" == "" ]]; then
        echo "TELENAV_WORKSPACE must be defined"
        exit 1
    fi

    cd "$TELENAV_WORKSPACE" || exit 1
}

show_workspace()
{
    echo " "
    echo "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ Telenav Workspace ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
    echo "┋"
    echo "┋        TELENAV_WORKSPACE: $TELENAV_WORKSPACE"

    if [[ -d "$KIVAKIT_HOME" ]]; then

        echo "┋"
        echo "┋             KIVAKIT_HOME: $KIVAKIT_HOME"
        echo "┋          KIVAKIT_VERSION: $KIVAKIT_VERSION"
        echo "┋       KIVAKIT_CACHE_HOME: $KIVAKIT_CACHE_HOME"
        echo "┋      KIVAKIT_ASSETS_HOME: $KIVAKIT_ASSETS_HOME"
        echo "┋     KIVAKIT_JAVA_OPTIONS: $KIVAKIT_JAVA_OPTIONS"

    fi

    if [[ -d "$MESAKIT_HOME" ]]; then

        echo "┋"
        echo "┋             MESAKIT_HOME: $MESAKIT_HOME"
        echo "┋          MESAKIT_VERSION: $MESAKIT_VERSION"
        echo "┋       MESAKIT_CACHE_HOME: $MESAKIT_CACHE_HOME"
        echo "┋      MESAKIT_ASSETS_HOME: $MESAKIT_ASSETS_HOME"
        echo "┋     MESAKIT_JAVA_OPTIONS: $MESAKIT_JAVA_OPTIONS"

    fi

    echo "┋"
    echo "┋                JAVA_HOME: $JAVA_HOME"
    echo "┋"
    echo "┋                  M2_HOME: $M2_HOME"
    echo "┋"
    perl -e 'print "┋                     PATH: " . join("\n┋                           ", split(":", $ENV{"PATH"})) . "\n"'
    echo "┋"
    echo "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
    echo " "
}

resolved_folders=()
export resolved_folders

resolve_scoped_folders()
{
    pattern=$1

    if [[ $pattern == "all" ]]; then
        pattern="kivakit|mesakit|cactus|lexakai"
    fi

    cd_workspace
    resolved_folders=()
    for folder in */; do
        if [[ "$folder" =~ $pattern ]]; then
            if [[ ! "$folder" == *"-assets"* ]]; then
                resolved_folders+=("$TELENAV_WORKSPACE/$folder")
            fi
        fi
    done
}

resolved_scope=""
resolved_families=()
export resolved_scope
export resolved_families

function join_by()
{
    local d=${1-} f=${2-}
    if shift 2; then
        printf %s "$f" "${@/#/$d}"
    fi
}

cactus_version()
{
    echo "1.4.18"
}

scope=""
branch=""
export scope
export branch

get_scope_and_branch_arguments()
{
    arguments=("$@")

    # If there is only one argument
    if [[ ${#arguments[@]} -eq 1 ]]; then

        # switch all project families to the given branch,
        scope="all-project-families"
        branch=${arguments[0]}

    # and if there are two arguments,
    elif [[ ${#arguments[@]} -eq 2 ]]; then

        # switch the scoped project families to the given branch,
        scope=${arguments[0]}
        branch=${arguments[1]}

    else

        # otherwise, exit with usage.
        echo "$(script) [scope]? [branch-name]"
        exit 1

    fi
}

get_scope_argument()
{
    arguments=("$@")

    # If there is only one argument
    if [[ ${#arguments[@]} -eq 1 ]]; then

        # that is the scope,
        scope=${arguments[0]}

    else

        # otherwise, exit with usage.
        echo "$(script) [scope]"
        exit 1

    fi
}

resolved_scope_switches=()
export resolved_scope_switches

resolve_scope_switches()
{
    scope=$1

    resolve_scope "$scope"

    families=$(join_by , "${resolved_families[@]}")

    if [[ ${#resolved_families[@]} == 1 ]]; then

        resolved_scope_switches=(-Dcactus.scope="$resolved_scope" -Dcactus.family="$families")

    else

        resolved_scope_switches=(-Dcactus.scope="$resolved_scope" -Dcactus.families="$families")

    fi
}

resolve_scope()
{
    scope=$1

    resolved_families=()

    case "${scope}" in

    "all")
        resolved_scope="all"
        ;;

    "all-project-families")
        resolved_scope="all-project-families"
        ;;

    "this")
        resolved_scope="just-this"
        ;;

    "just-this")
        resolved_scope="just-this"
        ;;

    *)
        if [[ "${scope}" == "" ]]; then

            if [[ "${TELENAV_SCOPE}" == "" ]]; then

                resolved_scope="all-project-families"

            else

                resolved_scope="$TELENAV_SCOPE"
                resolved_families=("$TELENAV_FAMILY")

            fi

        else

            resolved_scope="family"

            IFS=',' read -ra ARRAY <<< "$scope"
            for family in "${ARRAY[@]}"; do
                resolved_families+=("$family")
            done

        fi
        ;;

    esac
}

check_tools()
{
    caller=$1

    if [[ ! "$caller" == "ci-build" ]]; then
        require_variable M2_HOME "Must set M2_HOME"
        require_variable JAVA_HOME "Must set JAVA_HOME"
    fi

    #
    # Check tools
    #

    # 1) Parse Java version from output like: openjdk version "17.0.3" 2022-04-19 LTS
    java_version=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}')

    # 2) Parse Maven version from output like: Apache Maven 3.8.5 (3599d3414f046de2324203b78ddcf9b5e4388aa0)
    maven_version=$(mvn -version 2>&1 | awk -F ' ' '/Apache Maven/ {print $3}')

    # 3) Parse Git version from output like: git version 2.36.1
    git_version=$(git --version 2>&1 | awk -F' ' '{print $3}')

    # Check Java version
    if [[ ! "$java_version" == "17."* ]]; then
        echo "Telenav Open Source projects require Java 17"
        echo "To install: https://jdk.java.net/archive/"
        exit 1
    else
        echo "┋ Java $java_version"
    fi

    # Check Maven version
    if [[ ! $maven_version =~ 3\.8\.[5-9][0-9]* ]]; then
        echo "Telenav Open Source projects require Maven 3.8.5 or higher, but you have Maven $maven_version"
        echo "To upgrade: https://maven.apache.org/download.cgi"
        exit 1
    else
        echo "┋ Maven $maven_version"
    fi

    # Check Git version
    if [[ ! $git_version =~ 2\.3[0-9]\. ]]; then
        echo "Telenav Open Source projects require Git version 2.30 or higher"
        exit 1
    else
        echo "┋ Git $git_version"
    fi
}

project_version()
{
    project_home=$1

    pushd "$project_home" 1>/dev/null || exit 1
    mvn -q -DforceStdout org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version || exit 1
    popd 1>/dev/null || exit 1
}

project_name()
{
    project_home=$1

    # shellcheck disable=SC2046
    # shellcheck disable=SC2005
    echo $(basename -- "$project_home")
}

project_build()
{
    project_home=$1

    build_properties="$KIVAKIT_HOME/kivakit-core/target/classes/build.properties"

    if [ -e "$build_properties" ]; then

        build_name=$(property_value "$build_properties" build-name)
        build_number=$(property_value "$build_properties" build-number)
        build_date=$(property_value "$build_properties" build-date)

        branch_name=$(git_branch_name "$project_home")

        echo "$branch_name build #$build_number [$build_name] on $build_date"

    fi
}

show_version()
{
    project_home=$1
    project_name=$(project_name "$project_home")
    project_version=$(project_version "$project_home")

    echo -e "${ATTENTION}$project_name $project_version $(project_build "$project_home")${NORMAL}"
}

################ CLEAN ################################################################################################

allow_cleaning()
{
    if [ -z "$ALLOW_CLEANING" ]; then

        ALLOW_CLEANING=true

    fi

    if [ "$ALLOW_CLEANING" == "true" ]; then

        return 0

    else

        return 1

    fi
}

clean_caches()
{
    if allow_cleaning; then

        KIVAKIT_VERSION=$(project_version kivakit)
        clean_cache "$HOME/.kivakit/$KIVAKIT_VERSION"

        MESAKIT_VERSION=$(project_version mesakit)
        clean_cache "$HOME/.mesakit/$MESAKIT_VERSION"

    fi
}

clean_cache()
{
    cache=$1

    if [ -d "$cache" ]; then

        if yes_no "┋ Remove ALL cached files in $cache"; then

            rm -rf "$cache"

        fi
    fi
}

clean_maven_repository()
{
    if allow_cleaning; then

        project_home=$1
        name=$(basename -- "$project_home")

        if yes_no "┋ Remove all $name artifacts from $HOME/.m2/repository"; then

            rm -rf "$HOME/.m2/repository/com/telenav/$name"

        fi

    fi
}

clean_maven_repository_telenav()
{
    if allow_cleaning; then

        if [[ -d "$HOME/.m2/repository/com/telenav" ]]; then

            if yes_no "┋ Remove all Telenav artifacts from $HOME/.m2/repository"; then

                rm -rf "$HOME/.m2/repository/com/telenav"

            fi

        fi
    fi
}

clean_temporary_files()
{
    project_home=$1

    if allow_cleaning; then

        if yes_no "┋ Remove transient files from $project_home tree"; then

            # shellcheck disable=SC2038
            find "$project_home" \( -name \.DS_Store -o -name \.metadata -o -name \.classpath -o -name \.project -o -name \*\.hprof -o -name \*~ \) | xargs rm

        fi
    fi
}

remove_maven_repository()
{
    if allow_cleaning; then

        if [ -d "$HOME/.m2/repository" ]; then

            if yes_no "┋ Remove ALL artifacts in $HOME/.m2/repository"; then

                rm -rf "$HOME/.m2/repository"

            fi
        fi
    fi
}

################ GIT ################################################################################################

git_branch_name()
{
    project_home=$1

    cd "$project_home" || exit
    branch_name=$(git rev-parse --abbrev-ref HEAD)
    echo "$branch_name"
}

update_version_and_checkout()
{
    arguments=("$@")

    family=$1
    version=$2

    mvn -Dcactus.create.release.branch=true \
        -Dcactus.scope="family" \
        -Dcactus.family="$family" \
        -Dcactus.commit-changes=true \
        -Dcactus.explicit.version="$version" \
        com.telenav.cactus:cactus-maven-plugin:"$(cactus_version)":bump-version
}

git_check_branch_name()
{
    arguments=("$@")

    scope=$1
    branch=$2

    resolve_scope_switches "$scope"

    cd_workspace
    mvn "${resolved_scope_switches[@]}" \
        -Dcactus.expected.branch="$branch" \
        com.telenav.cactus:cactus-maven-plugin:"$(cactus_version)":check
}

git_checkout_branch()
{
    arguments=("$@")

    scope=$1
    branch=$2
    create=$3

    resolve_scope_switches "$scope"

    cd_workspace
    mvn --quiet \
        "${resolved_scope_switches[@]}" \
        -Dcactus.target-branch="$branch" \
        -Dcactus.update-root=true \
        -Dcactus.create-branches="$create" \
        -Dcactus.push=false \
        -Dcactus.permit-local-changes=true \
        com.telenav.cactus:cactus-maven-plugin:"$(cactus_version)":checkout || exit 1
}

git_repository_initialize()
{
    echo "Git pull fast-forward"
    git config pull.ff false || exit 1
    # shellcheck disable=SC2016
    git submodule foreach 'git config pull.ff false && echo "Configuring $name"' || exit 1
}

################ UTILITY ################################################################################################

script()
{
    # shellcheck disable=SC2046
    # shellcheck disable=SC2005
    echo $(basename -- "$0")
}

usage()
{
    argument_help=$1

    echo "Usage: $(script) $argument_help"
    exit 1
}

require_variable()
{
    variable=$1
    argument_help=$2

    if [[ -z "${!variable}" ]]; then

        if [[ "$argument_help" == *"["* ]]; then
            usage "$argument_help"
        else
            echo "$argument_help"
        fi

        exit 1

    fi
}

require_folder()
{
    variable=$1
    argument_help=$2

    if [[ ! -e "${!variable}" ]]; then

        echo "Folder '${!variable}' does not exist"
        exit 1

    fi
}

append_path()
{
    export PATH="$PATH:$1"
}

prepend_path()
{
    export PATH="$1:$PATH"
}

system_variable()
{
    variable=$1
    value=$2
    temporary="${TMPDIR}export.txt"

    echo "export $variable=\"$value\"" >"$temporary"
    # shellcheck disable=SC1090
    source "$temporary"

    if is_mac; then

        launchctl setenv "$variable" "$value"

    fi
}

is_mac()
{
    if [[ "$OSTYPE" == "darwin"* ]]; then
        true
    else
        false
    fi
}

lexakai()
{
    lexakai_download_version="1.0.7"
    lexakai_download_name="lexakai-1.0.7.jar"

    lexakai_downloads="$HOME/.lexakai/downloads"

    if [[ "$lexakai_download_version" == *"SNAPSHOT"* ]]; then

        lexakai_snapshot_repository="https://s01.oss.sonatype.org/content/repositories/snapshots/com/telenav/lexakai/lexakai"
        lexakai_url="$lexakai_snapshot_repository/${lexakai_download_version}/${lexakai_download_name}"
        lexakai_jar="${lexakai_downloads}/${lexakai_download_name}"

    else

        lexakai_url="https://repo1.maven.org/maven2/com/telenav/lexakai/lexakai/${lexakai_download_version}/lexakai-${lexakai_download_version}.jar"
        lexakai_jar="${lexakai_downloads}/lexakai-${lexakai_download_version}.jar"

    fi

    mkdir -p "${lexakai_downloads}"

    if [ ! -e "$lexakai_jar" ]; then

        echo "$lexakai_jar doesn't exist"

        wget $lexakai_url --output-document="$lexakai_jar"

    fi

    # -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=1044
    echo "java -jar $lexakai_jar $*"

    # shellcheck disable=SC2068
    java -jar "$lexakai_jar" $@
}

property_value()
{
    file=$1
    key=$2

    # shellcheck disable=SC2002
    cat "$file" | grep "$key" | cut -d'=' -f2 | xargs echo
}

bracket()
{
    name=$1
    shift

    echo " " && echo "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫ \$name && $*" && echo "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" && echo " "

}

ask()
{
    prompt=$1

    read -r -p "$prompt? "
    printf "\n"
}

yes_no()
{
    if [ -z "${NO_PROMPT}" ]; then

        prompt=$1

        read -p "$prompt (y/n)? " -n 1 -r
        printf "\n"

        if [[ $REPLY =~ ^[Yy]$ ]]; then
            true
        else
            false
        fi

    else

        true

    fi
}

#####################################################################################################################

[jonathanl-telenav]

working now