Added build log artifacts for easier debugging of workflow issues

SomeRandomiOSDev · SomeRandomiOSDev · commit ac3f2ad4f860 · 2021-11-05T17:28:33.000-04:00
diff --git a/.github/workflows/carthage.yml b/.github/workflows/carthage.yml
@@ -15,10 +15,17 @@ jobs:
   build:
     name: Build
     runs-on: macOS-latest
+    env:
+      LOGFILE: /tmp/.keyvalueobservation.carthage.xcodebuild.log
+
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name: Setup Environment
+      run |
+        touch "$LOGFILE"
+
     - name: Install Carthage
       run: |
         brew update
@@ -34,4 +41,11 @@ jobs:
 
     - name: Build
       run: |
-        ./scripts/carthage.sh update
+        ./scripts/carthage.sh update --log-path "$LOGFILE"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: BuildLog
+        path: ${{ env.LOGFILE }}
diff --git a/.github/workflows/cocoapods.yml b/.github/workflows/cocoapods.yml
@@ -20,12 +20,17 @@ jobs:
     name: Lint
     runs-on: macOS-latest
     env:
+      LOGSDIR: /tmp/.keyvalueobservation.cocoapods/Logs
       LINT_TYPE: ${{ matrix.linttype }}
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Setup Cocoapods
       uses: maxim-lobanov/setup-cocoapods@v1
       with:
@@ -34,7 +39,14 @@ jobs:
     - name: Lint
       run: |
         if [ "$LINT_TYPE" == "Dynamic" ]; then
-            pod lib lint
+            pod lib lint --verbose 2>&1 | tee "$LOGSDIR/PodLint-$LINT_TYPE.log"
         else
-            pod lib lint --use-libraries
+            pod lib lint --verbose --use-libraries 2>&1 | tee "$LOGSDIR/PodLint-$LINT_TYPE.log"
         fi
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: Logs
+        path: ${{ env.LOGSDIR }}/*.log
diff --git a/.github/workflows/xcframework.yml b/.github/workflows/xcframework.yml
@@ -24,4 +24,11 @@ jobs:
 
     - name: Build
       run: |
-        ./scripts/xcframework.sh --output ${TMPDIR}/KeyValueObservation.xcframework
+        ./scripts/xcframework.sh --build-dir "$TMPDIR"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: BuildLogs
+        path: ${{ env.TMPDIR }}/Logs/*.log
diff --git a/.github/workflows/xcodebuild.yml b/.github/workflows/xcodebuild.yml
@@ -15,18 +15,24 @@ jobs:
   ios:
     name: iOS
     runs-on: macOS-latest
+    env:
+      LOGSDIR: /tmp/.keyvalueobservation.xcodebuild/iOS/Logs
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Build iOS
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=iOS" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=iOS" -configuration Debug 2>&1 | tee "$LOGSDIR/build-ios.log"
 
     - name: Build iOS Simulator
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=iOS Simulator" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=iOS Simulator" -configuration Debug 2>&1 | tee "$LOGSDIR/build-iossimulator.log"
 
     - name: Test
       run: |
@@ -35,39 +41,65 @@ jobs:
             IOS_SIM = "iPhone 12 Pro" # Fallback Simulator
         fi
 
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -testPlan "KeyValueObservationTests" -destination "platform=iOS Simulator,name=$IOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -testPlan "KeyValueObservationTests" -destination "platform=iOS Simulator,name=$IOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test 2>&1 | tee "$LOGSDIR/test-ios.log"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: iOSBuildLogs
+        path: ${{ env.LOGSDIR }}/*.log
 
   maccatalyst:
     name: Mac Catalyst
     runs-on: macOS-latest
+    env:
+      LOGSDIR: /tmp/.keyvalueobservation.xcodebuild/macCatalyst/Logs
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Build
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=macOS,variant=Mac Catalyst" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -destination "generic/platform=macOS,variant=Mac Catalyst" -configuration Debug 2>&1 | tee "$LOGSDIR/build-maccatalyst.log"
 
     - name: Test
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -testPlan "KeyValueObservationTests" -destination "platform=macOS,variant=Mac Catalyst" -configuration Debug ONLY_ACTIVE_ARCH=YES test
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation" -testPlan "KeyValueObservationTests" -destination "platform=macOS,variant=Mac Catalyst" -configuration Debug ONLY_ACTIVE_ARCH=YES test 2>&1 | tee "$LOGSDIR/test-maccatalyst.log"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: MacCatalystBuildLogs
+        path: ${{ env.LOGSDIR }}/*.log
 
   macos:
     name: macOS
     runs-on: macOS-latest
+    env:
+      LOGSDIR: /tmp/.keyvalueobservation.xcodebuild/macOS/Logs
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Build
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation macOS" -destination "generic/platform=macOS" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation macOS" -destination "generic/platform=macOS" -configuration Debug 2>&1 | tee "$LOGSDIR/build-macos.log"
 
     - name: Test
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation macOS" -testPlan "KeyValueObservation macOS Tests" -derivedDataPath ".xcodebuild" -configuration Debug ONLY_ACTIVE_ARCH=YES test
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation macOS" -testPlan "KeyValueObservation macOS Tests" -derivedDataPath ".xcodebuild" -configuration Debug ONLY_ACTIVE_ARCH=YES test 2>&1 | tee "$LOGSDIR/test-macos.log"
 
     - name: Generate Code Coverage File
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
@@ -84,21 +116,34 @@ jobs:
         file: ./codecov.lcov
         verbose: true
 
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: macOSBuildLogs
+        path: ${{ env.LOGSDIR }}/*.log
+
   tvos:
     name: tvOS
     runs-on: macOS-latest
+    env:
+      LOGSDIR: /tmp/.keyvalueobservation.xcodebuild/tvOS/Logs
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Build tvOS
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -destination "generic/platform=tvOS" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -destination "generic/platform=tvOS" -configuration Debug 2>&1 | tee "$LOGSDIR/build-tvos.log"
 
     - name: Build tvOS Simulator
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -destination "generic/platform=tvOS Simulator" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -destination "generic/platform=tvOS Simulator" -configuration Debug 2>&1 | tee "$LOGSDIR/build-tvossimulator.log"
 
     - name: Test
       run: |
@@ -107,23 +152,36 @@ jobs:
             TVOS_SIM = "Apple TV" # Fallback Simulator
         fi
 
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -testPlan "KeyValueObservation tvOS Tests" -destination "platform=tvOS Simulator,name=$TVOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation tvOS" -testPlan "KeyValueObservation tvOS Tests" -destination "platform=tvOS Simulator,name=$TVOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test 2>&1 | tee "$LOGSDIR/test-tvos.log"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: tvOSBuildLogs
+        path: ${{ env.LOGSDIR }}/*.log
 
   watchos:
     name: watchOS
     runs-on: macOS-11
+    env:
+      LOGSDIR: /tmp/.keyvalueobservation.xcodebuild/watchOS/Logs
 
     steps:
     - name: Checkout Code
       uses: actions/checkout@v2
 
+    - name Setup Environment
+      run: |
+        mkdir -p "$LOGSDIR"
+
     - name: Build watchOS
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -destination "generic/platform=watchOS" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -destination "generic/platform=watchOS" -configuration Debug 2>&1 | tee "$LOGSDIR/build-watchos.log"
 
     - name: Build watchOS Simulator
       run: |
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -destination "generic/platform=watchOS Simulator" -configuration Debug
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -destination "generic/platform=watchOS Simulator" -configuration Debug 2>&1 | tee "$LOGSDIR/build-watchossimulator.log"
 
     - name: Test
       run: |
@@ -132,4 +190,11 @@ jobs:
             WATCHOS_SIM = "Apple Watch Series 6 - 44mm" # Fallback Simulator
         fi
 
-        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -testPlan "KeyValueObservation watchOS Tests" -destination "platform=watchOS Simulator,name=$WATCHOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test
+        xcodebuild -project KeyValueObservation.xcodeproj -scheme "KeyValueObservation watchOS" -testPlan "KeyValueObservation watchOS Tests" -destination "platform=watchOS Simulator,name=$WATCHOS_SIM" -configuration Debug ONLY_ACTIVE_ARCH=YES test 2>&1 | tee "$LOGSDIR/test-watchos.log"
+
+    - name: Upload Logs
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: watchOSBuildLogs
+        path: ${{ env.LOGSDIR }}/*.log
diff --git a/scripts/xcframework.sh b/scripts/xcframework.sh
@@ -20,6 +20,7 @@ function printhelp() {
     HELP+="xcframework.sh [--help | -h] [--output (<output_framework> | <output_folder>)]\n"
     HELP+="               [--configuration <configuration>] [--project-name <project_name>]\n"
     HELP+="               [--exclude-dsyms] [--verbose] [--no-clean | --no-clean-on-fail]\n"
+    HELP+="               [--build-dir <build_dir>]\n"
     HELP+="\n"
     HELP+="--help, -h)         Print this help message and exit.\n"
     HELP+="\n"
@@ -48,6 +49,11 @@ function printhelp() {
     HELP+="--no-clean-on-fail) Same as --no-clean with the exception that if the succeed\n"
     HELP+="                    clean up will continue as normal. This is mutually exclusive\n"
     HELP+="                    with --no-clean, with --no-clean taking precedence.\n"
+    HELP+="\n"
+    HELP+="--build-dir)        The directory in which to store temporary build artifacts\n"
+    HELP+="                    and logs. The directory will be created if needed. If\n"
+    HELP+="                    specified this directory will not be deleted when the\n"
+    HELP+="                    script finishes running.\n"
 
     IFS='%'
     echo -e $HELP 1>&2
@@ -93,6 +99,12 @@ while [[ $# -gt 0 ]]; do
         shift # --no-clean-on-fail
         ;;
 
+        --build-dir)
+        BUILD_DIR="$2"
+        shift # --build-dir
+        shift # <build_dir>
+        ;;
+
         --verbose)
         VERBOSE=1
         shift # --verbose
@@ -139,20 +151,29 @@ if [ -z ${CONFIGURATION+x} ]; then
     CONFIGURATION="Release"
 fi
 
-# Create Temporary Directory
+if [ -z ${BUILD_DIR+x} ]; then
+    BUILD_DIR="$(mktemp -d -t ".$(echo "$PROJECT_NAME" | tr '[:upper:]' '[:lower:]').xcframework.build")"
+    BUILD_DIR_IS_TEMP=1
+else
+    mkdir -p "$BUILD_DIR"
+    EXIT_CODE=$?
 
-TEMP_DIR="$(mktemp -d -t ".$(echo "$PROJECT_NAME" | tr '[:upper:]' '[:lower:]').xcframework.build")"
+    if [ "$EXIT_CODE" != "0" ]; then
+        "$SCRIPTS_DIR/printformat.sh" "foreground:red" "Unable to create build directory: $BUILD_DIR"
+        exit $EXIT_CODE
+    fi
+fi
 
 # Function Declarations
 
 function cleanup() {
     cd "$CURRENT_DIR"
-    if [[ "$VERBOSE" != "1" && ("$NO_CLEAN" == "1" || ("$NO_CLEAN_ON_FAIL" == "1" && "$EXIT_CODE" != "0")) ]]; then
+    if [[ "$VERBOSE" != "1" && "$BUILD_DIR_IS_TEMP" == "1" && ("$NO_CLEAN" == "1" || ("$NO_CLEAN_ON_FAIL" == "1" && "$EXIT_CODE" != "0")) ]]; then
         if [ "$EXIT_CODE" == "0" ]; then
-            "$SCRIPTS_DIR/printformat.sh" "foreground:yellow" "Build Directory: $TEMP_DIR"
+            "$SCRIPTS_DIR/printformat.sh" "foreground:yellow" "Build Directory: $BUILD_DIR"
         fi
-    else
-        rm -rf "$TEMP_DIR"
+    elif [ "$BUILD_DIR_IS_TEMP" == "1" ]; then
+        rm -rf "$BUILD_DIR"
     fi
 
     #
@@ -176,11 +197,11 @@ function checkresult() {
 }
 
 function createlogfile() {
-    if [ ! -d "$TEMP_DIR/Logs" ]; then
-        mkdir -p "$TEMP_DIR/Logs"
+    if [ ! -d "$BUILD_DIR/Logs" ]; then
+        mkdir -p "$BUILD_DIR/Logs"
     fi
 
-    local LOG="$TEMP_DIR/Logs/$1.log"
+    local LOG="$BUILD_DIR/Logs/$1.log"
     touch "$LOG"
 
     echo "$LOG"
@@ -264,14 +285,14 @@ for PLATFORM in "iOS" "iOS Simulator" "Mac Catalyst" "macOS" "tvOS" "tvOS Simula
     #
 
     if [ "$VERBOSE" == "1" ]; then
-        xcodebuild -project "${PROJECT_NAME}.xcodeproj" -scheme "$SCHEME" -destination "generic/platform=$PLATFORM" -archivePath "${TEMP_DIR}/$ARCHIVE.xcarchive" -configuration ${CONFIGURATION} SKIP_INSTALL=NO BUILD_LIBRARY_FOR_DISTRIBUTION=YES ONLY_ACTIVE_ARCH=NO ARCHS="$ARCHS" archive
+        xcodebuild -project "${PROJECT_NAME}.xcodeproj" -scheme "$SCHEME" -destination "generic/platform=$PLATFORM" -archivePath "${BUILD_DIR}/$ARCHIVE.xcarchive" -configuration ${CONFIGURATION} SKIP_INSTALL=NO BUILD_LIBRARY_FOR_DISTRIBUTION=YES ONLY_ACTIVE_ARCH=NO ARCHS="$ARCHS" archive
     else
         LOG="$(createlogfile "$ARCHIVE-build")"
         ERROR_MESSAGE="$(errormessage "$LOG")"
 
         #
 
-        xcodebuild -project "${PROJECT_NAME}.xcodeproj" -scheme "$SCHEME" -destination "generic/platform=$PLATFORM" -archivePath "${TEMP_DIR}/$ARCHIVE.xcarchive" -configuration ${CONFIGURATION} SKIP_INSTALL=NO BUILD_LIBRARY_FOR_DISTRIBUTION=YES ONLY_ACTIVE_ARCH=NO ARCHS="$ARCHS" archive > "$LOG" 2>&1
+        xcodebuild -project "${PROJECT_NAME}.xcodeproj" -scheme "$SCHEME" -destination "generic/platform=$PLATFORM" -archivePath "${BUILD_DIR}/$ARCHIVE.xcarchive" -configuration ${CONFIGURATION} SKIP_INSTALL=NO BUILD_LIBRARY_FOR_DISTRIBUTION=YES ONLY_ACTIVE_ARCH=NO ARCHS="$ARCHS" archive > "$LOG" 2>&1
     fi
 
     checkresult $? "$ERROR_MESSAGE"
@@ -285,7 +306,7 @@ fi
 
 ARGUMENTS=(-create-xcframework -output "${OUTPUT}")
 
-for ARCHIVE in ${TEMP_DIR}/*.xcarchive; do
+for ARCHIVE in ${BUILD_DIR}/*.xcarchive; do
     ARGUMENTS=(${ARGUMENTS[@]} -framework "${ARCHIVE}/Products/Library/Frameworks/${PROJECT_NAME}.framework")
 
     if [ "$EXCLUDE_DSYMS" != "1" ]; then
