chore(release): v0.22.1 (#1024)

Release v0.22.1.

Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>

Author: tenthirtyam

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History
 
+## v0.22.1
+
+> Release Date: 2025-03-05
+
+**Bug Fix**:
+
+- Fixes issue with `config.sh` not creating the default or specified configuration path.
+  [#1024](https://github.com/vmware-samples/packer-examples-for-vsphere/pull/1024)
+
 ## v0.22.0
 
 > Release Date: 2025-02-11

config.sh

@@ -6,80 +6,95 @@
 set -e
 
 follow_link() {
-    FILE="${1}"
-    while [ -h "${FILE}" ]; do
-        # On macOS, readlink -f doesn't work.
-        FILE="$(readlink "${FILE}")"
+    local file="$1"
+    while [[ -h "${file}" ]]; do
+        file="$(readlink "${file}")"
+        if [[ ! -e "${file}" ]]; then
+        echo "Error: Broken symbolic link: $1" >&2
+        exit 1
+        fi
     done
-    echo "${FILE}"
+    printf '%s\n' "${file}"
 }
 
-# This function displays the help message.
 show_help() {
-    local exit_after=${1:-"exit"}
-    script_name=$(basename "$0")
-
-    printf "\033[0;32m Usage\033[0m: %s [options] [config_path]\n\n" "$script_name"
-    printf "\033[0;34m Options:\033[0m\n"
-    printf "  \033[0;34m --help, -h, -H\033[0m       Display this help message.\n\n"
-    printf "\033[0;34m config_path:\033[0m\n"
-    printf "  \033[0m Path to save the generated configuration files. (Optional).\n\n"
-
-    # Handle user input or exit.
-    if [[ -z "$input" ]]; then
-        [ "$exit_after" = "exit" ] && exit 0
-    else
-        press_enter_continue
+    local exit_after="${1:-exit}"
+    local script_name="$(basename "$0")"
+
+    printf 'Usage: %s [options] [config_path]\n\n' "${script_name}"
+    printf 'Options:\n'
+    printf '  --help, -h, -H       Display this help message.\n\n'
+    printf 'config_path:\n'
+    printf '  Path to save the generated configuration files. (Optional).\n\n'
+
+    if [[ -z "${input}" ]]; then
+        if [[ "${exit_after}" == "exit" ]]; then
+        exit 0
+        fi
     fi
+    read -p "Press Enter to continue..."
 }
 
-# Define the script and default config paths
-follow_link_result=$(follow_link "$0")
-if ! SCRIPT_PATH=$(realpath "$(dirname "${follow_link_result}")"); then
-    echo "Error: follow_link or realpath failed"
+script_path="$(dirname "$(follow_link "$0")")"
+
+config_path="${1:-${script_path}/config}"
+
+if [[ "$1" == "--help" || "$1" == "-h" || "$1" == "-H" ]]; then
+    show_help
+    exit 0
+fi
+
+if ! mkdir -p "${config_path}"; then
+    echo "Error: Failed to create directory: ${config_path}" >&2
     exit 1
 fi
 
-# Set config_path if it's not already set
-if [ -z "$CONFIG_PATH" ]; then
-    CONFIG_PATH=$(
-        cd "${SCRIPT_PATH}/config" || exit
-        pwd
-    )
+backup_dir=""
+backup_taken=0
+
+if [[ -d "${config_path}" && "$(find "${config_path}" -maxdepth 1 -type f -name "*.hcl" -print -quit 2>/dev/null)" ]]; then
+    echo "> Backing up existing configurations..."
+    backup_time=$(date +%Y%m%d-%H%M%S)
+    backup_dir="${config_path}/backup.${backup_time}"
+    if ! mkdir -p "${backup_dir}"; then
+        echo "Error: Failed to create backup directory: ${backup_dir}" >&2
+        exit 1
+    fi
+    find "${config_path}" -maxdepth 1 -type f -name "*.hcl" -print0 |
+        xargs -0 -I {} bash -c 'if mv "$1" "${2}/$(basename "$1")"; then :; else echo "Error moving $1"; exit 1; fi' -- {} "${backup_dir}"
+    if [[ $? -ne 0 ]]; then
+        echo "Error: Some configuration files failed to move to backup" >&2
+        exit 1
+    fi
+    if ! rm -f "${config_path}"/*.hcl; then
+        echo "Error: Failed to remove original configuration files" >&2
+        exit 1
+    fi
+    backup_taken=1
+    echo "> Backup created: ${backup_dir}"
 fi
 
-# Script options.
-while (("$#")); do
-    case "$1" in
-    --help | -h | -H)
-        run_show_help=true
-        show_help
-        shift
-        ;;
-    *)
-        CONFIG_PATH=$(realpath "$1")
-        shift
-        ;;
-    esac
-done
+cp -av "${script_path}"/builds/*.pkrvars.hcl.example "${config_path}" 2>&1 >/dev/null
 
-mkdir -p "${CONFIG_PATH}"
-### Copy the example input variables.
-echo
-echo "> Copying the example input variables..."
-cp -av "${SCRIPT_PATH}"/builds/*.pkrvars.hcl.example "${CONFIG_PATH}"
-find "${SCRIPT_PATH}"/builds/*/ -type f -name "*.pkrvars.hcl.example" | while IFS= read -r srcfile; do
+find "${script_path}"/builds/*/ -type f -name "*.pkrvars.hcl.example" -print0 | while IFS= read -r -d $'\0' srcfile; do
     srcdir=$(dirname "${srcfile}" | tr -s /)
-    dstfile=$(echo "${srcdir#"${SCRIPT_PATH}"/builds/}" | tr '/' '-')
-    cp -av "${srcfile}" "${CONFIG_PATH}/${dstfile}.pkrvars.hcl.example"
+    dstfile=$(echo "${srcdir#"${script_path}"/builds/}" | tr '/' '-')
+    cp -av "${srcfile}" "${config_path}/${dstfile}.pkrvars.hcl.example" 2>&1 >/dev/null
+    if [[ $? -ne 0 ]]; then
+        echo "Error: Failed to copy ${srcfile} to ${config_path}/${dstfile}.pkrvars.hcl.example" >&2
+    fi
 done
 
-### Rename the example input variables.
-echo
-echo "> Renaming the example input variables..."
-for file in "${CONFIG_PATH}"/*.pkrvars.hcl.example; do
-    mv -i -- "${file}" "${file%.example}"
+if [[ $? -ne 0 ]]; then
+    echo "Error: One or more copy operations failed." >&2
+    exit 1
+fi
+
+for file in "${config_path}"/*.pkrvars.hcl.example; do
+    if ! mv -- "${file}" "${file%.example}"; then
+        echo "Error: Failed to rename ${file}" >&2
+        exit 1
+    fi
 done
 
-echo
-echo "> Done."
+echo "> Configuration setup complete: ${config_path}"

docs/getting-started/get-project.md

@@ -27,11 +27,19 @@ You can choose between two options to get the source code:
 === ":octicons-repo-clone-24:   Clone the Repository"
 
       ```shell
-      TAG_NAME=$(curl -s https://api.github.com/repos/vmware-samples/packer-examples-for-vsphere/releases | jq  -r '.[0].tag_name')
+      TAG_NAME=$(curl -s https://api.github.com/repos/vmware-samples/packer-examples-for-vsphere/releases | jq -r '.[0].tag_name')
 
+      BRANCH_NAME="${TAG_NAME//\//-}"
+      
       git clone https://github.com/vmware-samples/packer-examples-for-vsphere.git
       cd packer-examples-for-vsphere
-      git switch -c $TAG_NAME $TAG_NAME
+      
+      if git switch -c "$BRANCH_NAME" "$TAG_NAME"; then
+            echo "Switched to new branch: $BRANCH_NAME"
+      else
+            echo "Failed to switch to branch: $BRANCH_NAME"
+            exit 1
+      fi
       ```
 
 ???+ tip "Prerelease Updates"

project.json

@@ -1,7 +1,7 @@
 {
     "project": {
         "name": "Packer Examples for vSphere",
-        "version": "develop",
+        "version": "v0.22.1",
         "description": "This project provides a collection of opinionated examples that demonstrate how you can use both\nHashiCorp Packer and the Packer Plugin for VMware vSphere (vsphere-iso builder) to automate the\ncreation of virtual machine images for VMware vSphere environments.\n\nWhether you're a developer, systems administrator, or site reliability engineer, this project is\ndesigned to both help and inspire you in streamlining your infrastructure provisioning process and\nmaintain consistency in your virtualization workflow.",
         "urls": {
             "github": "https://github.com/vmware-samples/packer-examples-for-vsphere",
@@ -919,7 +919,7 @@
                 "name": "Red Hat",
                 "url": "https://redhat.com"
             },
-            "version_requirement": ">= 2.16.0"
+            "version_requirement": ">= 2.15.0"
         },
         {
             "name": "git",