Update DocC script

Author: danielsaidi

RELEASE_NOTES.md

@@ -1,6 +1,16 @@
 # RELEASE NOTES
 
 
+## 1.0.1
+
+This version updates `docc.sh` to support DocC hosted on a custom domain.
+
+## 💡 Changes
+
+* `docc.sh` now allows you to pass in a `--hosting-base-path`.
+
+
+
 ## 1.0
 
 This version updates all `.github` and `scripts` scripts.

scripts/docc.sh

@@ -12,20 +12,23 @@ show_usage() {
     echo "This script builds DocC for a <TARGET> and certain <PLATFORMS>."
 
     echo
-    echo "Usage: $0 [TARGET] [-p|--platforms <PLATFORM1> <PLATFORM2> ...]"
+    echo "Usage: $0 [TARGET] [-p|--platforms <PLATFORM1> <PLATFORM2> ...] [--hosting-base-path <PATH>]"
     echo "  [TARGET]              Optional. The target to build documentation for (defaults to package name)"
     echo "  -p, --platforms       Optional. List of platforms (default: iOS macOS tvOS watchOS xrOS)"
-    
+    echo "  --hosting-base-path   Optional. Base path for static hosting (default: TARGET name, use empty string \"\" for root)"
+
     echo
     echo "The documentation ends up in .build/docs-<PLATFORM>."
-    
+
     echo
     echo "Examples:"
     echo "  $0"
     echo "  $0 MyTarget"
     echo "  $0 -p iOS macOS"
     echo "  $0 MyTarget -p iOS macOS"
     echo "  $0 MyTarget --platforms iOS macOS tvOS watchOS xrOS"
+    echo "  $0 MyTarget --hosting-base-path \"\""
+    echo "  $0 MyTarget --hosting-base-path \"custom/path\""
     echo
 }
 
@@ -41,26 +44,35 @@ show_error_and_exit() {
 # Define argument variables
 TARGET=""
 PLATFORMS="iOS macOS tvOS watchOS xrOS"  # Default platforms
+HOSTING_BASE_PATH=""  # Will be set to TARGET if not specified
 
 # Parse command line arguments
 while [[ $# -gt 0 ]]; do
     case $1 in
         -p|--platforms)
             shift  # Remove --platforms from arguments
             PLATFORMS=""  # Clear default platforms
-            
+
             # Collect all platform arguments until we hit another flag or run out of args
             while [[ $# -gt 0 && ! "$1" =~ ^- ]]; do
                 PLATFORMS="$PLATFORMS $1"
                 shift
             done
-            
+
             # Remove leading space and check if we got any platforms
             PLATFORMS=$(echo "$PLATFORMS" | sed 's/^ *//')
             if [ -z "$PLATFORMS" ]; then
                 show_error_and_exit "--platforms requires at least one platform"
             fi
             ;;
+        --hosting-base-path)
+            shift  # Remove --hosting-base-path from arguments
+            if [[ $# -eq 0 ]]; then
+                show_error_and_exit "--hosting-base-path requires a value (use \"\" for empty path)"
+            fi
+            HOSTING_BASE_PATH="$1"
+            shift
+            ;;
         -h|--help)
             show_usage; exit 0 ;;
         -*)
@@ -81,7 +93,7 @@ if [ -z "$TARGET" ]; then
     # Use the script folder to refer to other scripts
     FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
     SCRIPT_PACKAGE_NAME="$FOLDER/package_name.sh"
-    
+
     # Check if package_name.sh exists
     if [ -f "$SCRIPT_PACKAGE_NAME" ]; then
         echo "No target provided, attempting to get package name..."
@@ -103,6 +115,11 @@ if [ -z "$TARGET" ]; then
     fi
 fi
 
+# Set default hosting base path if not specified
+if [ -z "$HOSTING_BASE_PATH" ] && [ "$HOSTING_BASE_PATH" != "" ]; then
+    HOSTING_BASE_PATH="$TARGET"
+fi
+
 # Define target lowercase for redirect script
 TARGET_LOWERCASED=$(echo "$TARGET" | tr '[:upper:]' '[:lower:]')
 
@@ -145,11 +162,18 @@ build_platform() {
         return 1
     fi
 
-    # Transform docs for static hosting
-    if ! $(xcrun --find docc) process-archive \
-      transform-for-static-hosting .build/docbuild/Build/Products/$DEBUG_PATH/$TARGET.doccarchive \
-      --output-path .build/docs-$PLATFORM \
-      --hosting-base-path "$TARGET"; then
+    # Transform docs for static hosting with configurable base path
+    local DOCC_COMMAND="$(xcrun --find docc) process-archive transform-for-static-hosting .build/docbuild/Build/Products/$DEBUG_PATH/$TARGET.doccarchive --output-path .build/docs-$PLATFORM"
+
+    # Add hosting-base-path only if it's not empty
+    if [ -n "$HOSTING_BASE_PATH" ]; then
+        DOCC_COMMAND="$DOCC_COMMAND --hosting-base-path \"$HOSTING_BASE_PATH\""
+        echo "Using hosting base path: '$HOSTING_BASE_PATH'"
+    else
+        echo "Using empty hosting base path (root level)"
+    fi
+
+    if ! eval "$DOCC_COMMAND"; then
         echo "Failed to transform documentation for $PLATFORM"
         return 1
     fi
@@ -164,6 +188,11 @@ build_platform() {
 # Start script
 echo
 echo "Building $TARGET docs for [$PLATFORMS]..."
+if [ -n "$HOSTING_BASE_PATH" ]; then
+    echo "Hosting base path: '$HOSTING_BASE_PATH'"
+else
+    echo "Hosting base path: (empty - root level)"
+fi
 
 # Loop through all platforms and call the build function
 for PLATFORM in $PLATFORMS; do
@@ -175,4 +204,4 @@ done
 # Complete successfully
 echo
 echo "Building $TARGET docs completed successfully!"
-echo
+echo