diff --git a/.github/workflows/reusable-build-workflow.yml b/.github/workflows/reusable-build-workflow.yml index 93dc8ae8..4fd821a1 100644 --- a/.github/workflows/reusable-build-workflow.yml +++ b/.github/workflows/reusable-build-workflow.yml @@ -1,4 +1,5 @@ name: Reusable SideStore Build + on: workflow_call: inputs: @@ -44,10 +45,28 @@ on: required: false jobs: - build: - name: Build and upload SideStore ${{ inputs.release_tag }} releases + serialize: + name: Wait for other jobs concurrency: group: build-number-increment # serialize for build num cache access + strategy: + fail-fast: false + runs-on: 'macos-15' + steps: + - run: echo "No other contending jobs are running now...Build is ready to start" + - name: Set short commit hash + id: commit-id + run: | + # SHORT_COMMIT="${{ github.sha }}" + SHORT_COMMIT=${GITHUB_SHA:0:7} + echo "Short commit hash: $SHORT_COMMIT" + echo "SHORT_COMMIT=$SHORT_COMMIT" >> $GITHUB_OUTPUT + outputs: + short-commit: ${{ steps.commit-id.outputs.SHORT_COMMIT }} + + build: + name: Build SideStore - ${{ inputs.release_tag }} + needs: serialize strategy: fail-fast: false matrix: @@ -56,8 +75,11 @@ jobs: version: '16.1' runs-on: ${{ matrix.os }} - steps: + outputs: + version: ${{ steps.version.outputs.version }} + release-channel: ${{ steps.release-channel.outputs.RELEASE_CHANNEL }} + steps: - name: Set beta status run: echo "IS_BETA=${{ inputs.is_beta }}" >> $GITHUB_ENV @@ -66,13 +88,6 @@ jobs: with: submodules: recursive - # dispatch simulator boot in bg coz it take a while to boot-up fresh - - name: Boot Simulator for testing - run: | - mkdir -p build/logs - make -B boot-sim-async | tee -a build/logs/test.log - exit ${PIPESTATUS[0]} - - name: Install dependencies - ldid & xcbeautify & xcpretty run: | brew install ldid xcbeautify @@ -96,7 +111,7 @@ jobs: ref: ${{ env.ref }} token: ${{ secrets.CROSS_REPO_PUSH_KEY }} path: 'SideStore/beta-build-num' - + - name: Copy build_number.txt to repo root if: ${{ inputs.is_beta }} run: | @@ -108,13 +123,16 @@ jobs: run: | echo "cat Build.xcconfig" cat Build.xcconfig - + - name: Set Release Channel info for build number bumper + id: release-channel run: | - echo "RELEASE_CHANNEL=${{ inputs.release_tag }}" >> $GITHUB_ENV + RELEASE_CHANNEL="${{ inputs.release_tag }}" + echo "RELEASE_CHANNEL=${RELEASE_CHANNEL}" >> $GITHUB_ENV + echo "RELEASE_CHANNEL=${RELEASE_CHANNEL}" >> $GITHUB_OUTPUT echo "RELEASE_CHANNEL=${RELEASE_CHANNEL}" - + - name: Increase build number for beta builds if: ${{ inputs.is_beta }} run: | @@ -127,13 +145,6 @@ jobs: echo "version=$version" >> $GITHUB_OUTPUT echo "version=$version" - - name: Get short commit hash - run: | - # SHORT_COMMIT="${{ github.sha }}" - SHORT_COMMIT=${GITHUB_SHA:0:7} - echo "Short commit hash: $SHORT_COMMIT" - echo "SHORT_COMMIT=$SHORT_COMMIT" >> $GITHUB_ENV - - name: Set MARKETING_VERSION if: ${{ inputs.is_beta }} run: | @@ -145,7 +156,7 @@ jobs: build_num=$(echo "${{ steps.version.outputs.version }}" | sed -E 's/.*\.([0-9]+)\+.*/\1/') # Combine them into the final output - MARKETING_VERSION="${version}-${date}.${build_num}+${SHORT_COMMIT}" + MARKETING_VERSION="${version}-${date}.${build_num}+${{ needs.serialize.outputs.short-commit }}" echo "MARKETING_VERSION=$MARKETING_VERSION" >> $GITHUB_ENV echo "MARKETING_VERSION=$MARKETING_VERSION" @@ -161,16 +172,16 @@ jobs: with: xcode-version: ${{ matrix.version }} - - name: Cache Build + - name: (Build) Cache Build uses: irgaly/xcode-cache@v1 with: - key: xcode-cache-deriveddata-${{ github.sha }} - restore-keys: xcode-cache-deriveddata- - swiftpm-cache-key: xcode-cache-sourcedata-${{ github.sha }} + key: xcode-cache-deriveddata-build-${{ github.sha }} + restore-keys: xcode-cache-deriveddata-build- + swiftpm-cache-key: xcode-cache-sourcedata-build-${{ github.sha }} swiftpm-cache-restore-keys: | - xcode-cache-sourcedata- + xcode-cache-sourcedata-build- - - name: Restore Pods from Cache (Exact match) + - name: (Build) Restore Pods from Cache (Exact match) id: pods-restore uses: actions/cache/restore@v3 with: @@ -178,12 +189,12 @@ jobs: ./Podfile.lock ./Pods/ ./AltStore.xcworkspace/ - key: pods-cache-${{ hashFiles('Podfile') }} + key: pods-cache-build-${{ hashFiles('Podfile') }} # restore-keys: | # commented out to strictly check cache for this particular podfile # pods-cache- - - - name: Restore Pods from Cache (Last Available) - if: ${{ steps.pods-restore.outputs.cache-hit != 'true' }} + + - name: (Build) Restore Pods from Cache (Last Available) + if: ${{ steps.pods-restore.outputs.cache-hit != 'true' }} id: pods-restore-recent uses: actions/cache/restore@v3 with: @@ -191,13 +202,13 @@ jobs: ./Podfile.lock ./Pods/ ./AltStore.xcworkspace/ - key: pods-cache- + key: pods-cache-build- - - name: Install CocoaPods + - name: (Build) Install CocoaPods run: pod install - - name: Save Pods to Cache + - name: (Build) Save Pods to Cache id: save-pods if: ${{ steps.pods-restore.outputs.cache-hit != 'true' }} uses: actions/cache/save@v3 @@ -206,15 +217,15 @@ jobs: ./Podfile.lock ./Pods/ ./AltStore.xcworkspace/ - key: pods-cache-${{ hashFiles('Podfile') }} + key: pods-cache-build-${{ hashFiles('Podfile') }} - - name: Clean previous build artifacts + - name: (Build) Clean previous build artifacts # using 'tee' to intercept stdout and log for detailed build-log run: | make clean mkdir -p build/logs - - - name: List Files and derived data + + - name: (Build) List Files and derived data if: always() run: | echo ">>>>>>>>> Workdir <<<<<<<<<<" @@ -241,7 +252,7 @@ jobs: run: | echo "BUNDLE_ID_SUFFIX=${{ inputs.bundle_id_suffix }}" >> $GITHUB_ENV - + - name: Build SideStore.xcarchive # using 'tee' to intercept stdout and log for detailed build-log run: | @@ -253,35 +264,7 @@ jobs: - name: Convert to IPA run: make ipa | tee -a build/logs/build.log - - # we expect simulator to have been booted by now, so exit otherwise - - name: Simulator Boot Check - run: | - mkdir -p build/logs - make -B sim-boot-check | tee -a build/logs/test.log - exit ${PIPESTATUS[0]} - - - name: Start Recording UI tests (if DEBUG_RECORD_TESTS is set to 1) - if: ${{ vars.DEBUG_RECORD_TESTS == '1' }} - run: | - nohup xcrun simctl io booted recordVideo -f test-recording.mp4 --codec h264 test-recording.log 2>&1 & - RECORD_PID=$! - echo "RECORD_PID=$RECORD_PID" >> $GITHUB_ENV - - # build will be up-to-date from previous step so here only test will be executed directly - - name: Run SideStore Tests - # using 'tee' to intercept stdout and log for detailed build-log - run: | - NSUnbufferedIO=YES make -B build-and-test 2>&1 | tee -a build/logs/test.log | xcbeautify --renderer github-actions && exit ${PIPESTATUS[0]} - # NSUnbufferedIO=YES make -B build-and-test 2>&1 | tee build/logs/test.log | xcpretty -r junit --output ./build/tests/test-results.xml && exit ${PIPESTATUS[0]} - - - name: Stop Recording tests - if: ${{ always() && env.RECORD_PID != '' }} - run: | - kill -INT ${{ env.RECORD_PID }} - - - name: List Files and Build artifacts - if: always() + - name: (Build) List Files and Build artifacts run: | echo ">>>>>>>>> Workdir <<<<<<<<<<" ls -la . @@ -291,13 +274,16 @@ jobs: find build -maxdepth 3 -exec ls -ld {} + || true # List contents if directory exists echo "" + echo ">>>>>>>>> SideStore <<<<<<<<<<" + find SideStore -maxdepth 3 -exec ls -ld {} + || true # List contents if directory exists + echo "" + echo ">>>>>>>>> SideStore.xcarchive <<<<<<<<<<" find SideStore.xcarchive -maxdepth 3 -exec ls -ld {} + || true # List contents if directory exists echo "" - name: Encrypt build-logs for upload id: encrypt-build-log - if: always() run: | DEFAULT_BUILD_LOG_PASSWORD=12345 @@ -307,68 +293,285 @@ jobs: if [ "$BUILD_LOG_ZIP_PASSWORD" == "$DEFAULT_BUILD_LOG_PASSWORD" ]; then echo "Warning: BUILD_LOG_ZIP_PASSWORD is not set. Defaulting to '${DEFAULT_BUILD_LOG_PASSWORD}'." fi - + pushd build/logs && zip -e -P "$BUILD_LOG_ZIP_PASSWORD" ../../encrypted-build-logs.zip * || popd echo "::set-output name=encrypted::true" - name: Upload encrypted-build-logs.zip id: attach-encrypted-build-log - if: always() && steps.encrypt-build-log.outputs.encrypted == 'true' + if: ${{ always() && steps.encrypt-build-log.outputs.encrypted == 'true' }} uses: actions/upload-artifact@v4 with: name: encrypted-build-logs-${{ steps.version.outputs.version }}.zip path: encrypted-build-logs.zip - - name: Print test-recording.log contents (if exists) - if: ${{ always() && env.RECORD_PID != '' }} - run: | - if [ -f test-recording.log ]; then - echo "test-recording.log found. Its contents:" - cat test-recording.log - else - echo "test-recording.log not found." - fi - - - name: Check for test-recording.mp4 presence - id: check-recording - if: ${{ always() && env.RECORD_PID != '' }} - run: | - if [ -f test-recording.mp4 ]; then - echo "::set-output name=found::true" - echo "test-recording.mp4 found." - else - echo "test-recording.mp4 not found, skipping upload." - echo "::set-output name=found::false" - fi - - - name: Upload test-recording.mp4 - id: upload-recording - if: ${{ always() && steps.check-recording.outputs.found == 'true' }} - uses: actions/upload-artifact@v4 - with: - name: test-recording-${{ steps.version.outputs.version }}.mp4 - path: test-recording.mp4 - - - name: Upload Test Artifacts - uses: actions/upload-artifact@v4 - with: - name: test-results-${{ steps.version.outputs.version }}.zip - path: ./build/tests/* - - name: Upload SideStore.ipa Artifact uses: actions/upload-artifact@v4 with: name: SideStore-${{ steps.version.outputs.version }}.ipa path: SideStore.ipa + - name: Zip dSYMs + run: zip -r -9 ./SideStore.dSYMs.zip ./SideStore.xcarchive/dSYMs + - name: Upload *.dSYM Artifact uses: actions/upload-artifact@v4 with: - name: SideStore-${{ steps.version.outputs.version }}-dSYM - path: ./SideStore.xcarchive/dSYMs/* + name: SideStore-${{ steps.version.outputs.version }}-dSYMs.zip + path: SideStore.dSYMs.zip + + - name: Zip beta-beta-build-num & update_apps.py + run: | + zip -r -9 ./beta-build-num.zip ./SideStore/beta-build-num update_apps.py + + - name: Upload beta-build-num artifact + if: ${{ inputs.is_beta }} + uses: actions/upload-artifact@v4 + with: + name: beta-build-num-${{ steps.version.outputs.version }}.zip + path: beta-build-num.zip - + # test: + # name: Test SideStore - ${{ inputs.release_tag }} + # needs: serialize + # strategy: + # fail-fast: false + # matrix: + # include: + # - os: 'macos-15' + # version: '16.1' + # runs-on: ${{ matrix.os }} + + # steps: + # - name: Checkout code + # uses: actions/checkout@v4 + # with: + # submodules: recursive + + # - name: Boot Simulator for testing + # run: | + # mkdir -p build/logs + # make -B boot-sim-async | tee -a build/logs/test.log + # exit ${PIPESTATUS[0]} + + # - name: Install dependencies - ldid & xcbeautify & xcpretty + # run: | + # brew install ldid xcbeautify + # gem install xcpretty + + # - name: Setup Xcode + # uses: maxim-lobanov/setup-xcode@v1.6.0 + # with: + # xcode-version: '16.1' + + # - name: (Test) Cache Build + # uses: irgaly/xcode-cache@v1 + # with: + # key: xcode-cache-deriveddata-test-${{ github.sha }} + # restore-keys: xcode-cache-deriveddata-test- + # swiftpm-cache-key: xcode-cache-sourcedata-test-${{ github.sha }} + # swiftpm-cache-restore-keys: | + # xcode-cache-sourcedata-test- + + # - name: (Test) Restore Pods from Cache (Exact match) + # id: pods-restore + # uses: actions/cache/restore@v3 + # with: + # path: | + # ./Podfile.lock + # ./Pods/ + # ./AltStore.xcworkspace/ + # key: pods-cache-test-${{ hashFiles('Podfile') }} + + # - name: (Test) Restore Pods from Cache (Last Available) + # if: ${{ steps.pods-restore.outputs.cache-hit != 'true' }} + # id: pods-restore-recent + # uses: actions/cache/restore@v3 + # with: + # path: | + # ./Podfile.lock + # ./Pods/ + # ./AltStore.xcworkspace/ + # key: pods-cache-test- + + # - name: (Test) Install CocoaPods + # run: pod install + + # - name: (Test) Save Pods to Cache + # if: ${{ steps.pods-restore.outputs.cache-hit != 'true' }} + # uses: actions/cache/save@v3 + # with: + # path: | + # ./Podfile.lock + # ./Pods/ + # ./AltStore.xcworkspace/ + # key: pods-cache-test-${{ hashFiles('Podfile') }} + + # - name: (Test) Clean previous build artifacts + # run: | + # make clean + # mkdir -p build/logs + + # - name: (Test) List Files and derived data + # run: | + # echo ">>>>>>>>> Workdir <<<<<<<<<<" + # ls -la . + # echo "" + + # echo ">>>>>>>>> Pods <<<<<<<<<<" + # find Pods -maxdepth 2 -exec ls -ld {} + || true # List contents if directory exists + # echo "" + + # echo ">>>>>>>>> SideStore <<<<<<<<<<" + # find SideStore -maxdepth 2 -exec ls -ld {} + || true # List contents if directory exists + # echo "" + + # echo ">>>>>>>>> Dependencies <<<<<<<<<<" + # find Dependencies -maxdepth 2 -exec ls -ld {} + || true # List contents if directory exists + # echo "" + + # echo ">>>>>>>>> Xcode-Derived-Data <<<<<<<<<<" + # ls -la ~/Library/Developer/Xcode/DerivedData || true # List contents if directory exists + # echo "" + + # # we expect simulator to have been booted by now, so exit otherwise + # - name: Simulator Boot Check + # run: | + # mkdir -p build/logs + # make -B sim-boot-check | tee -a build/logs/test.log + # exit ${PIPESTATUS[0]} + + # - name: Start Recording UI tests (if DEBUG_RECORD_TESTS is set to 1) + # if: ${{ vars.DEBUG_RECORD_TESTS == '1' }} + # run: | + # nohup xcrun simctl io booted recordVideo -f test-recording.mp4 --codec h264 test-recording.log 2>&1 & + # RECORD_PID=$! + # echo "RECORD_PID=$RECORD_PID" >> $GITHUB_ENV + + # # build will be up-to-date from previous step so here only test will be executed directly + # - name: Run SideStore Tests + # # using 'tee' to intercept stdout and log for detailed build-log + # run: | + # NSUnbufferedIO=YES make -B build-and-test 2>&1 | tee -a build/logs/test.log | xcbeautify --renderer github-actions && exit ${PIPESTATUS[0]} + # # NSUnbufferedIO=YES make -B build-and-test 2>&1 | tee build/logs/test.log | xcpretty -r junit --output ./build/tests/test-results.xml && exit ${PIPESTATUS[0]} + + # - name: Stop Recording tests + # if: ${{ always() && env.RECORD_PID != '' }} + # run: | + # kill -INT ${{ env.RECORD_PID }} + + # - name: (Test) List Files and Build artifacts + # if: always() + # run: | + # echo ">>>>>>>>> Workdir <<<<<<<<<<" + # ls -la . + # echo "" + + # echo ">>>>>>>>> Build <<<<<<<<<<" + # find build -maxdepth 3 -exec ls -ld {} + || true # List contents if directory exists + # echo "" + + # - name: Encrypt test-logs for upload + # id: encrypt-test-log + # if: always() + # run: | + # DEFAULT_BUILD_LOG_PASSWORD=12345 + + # BUILD_LOG_ZIP_PASSWORD=${{ secrets.BUILD_LOG_ZIP_PASSWORD }} + # BUILD_LOG_ZIP_PASSWORD=${BUILD_LOG_ZIP_PASSWORD:-$DEFAULT_BUILD_LOG_PASSWORD} + + # if [ "$BUILD_LOG_ZIP_PASSWORD" == "$DEFAULT_BUILD_LOG_PASSWORD" ]; then + # echo "Warning: BUILD_LOG_ZIP_PASSWORD is not set. Defaulting to '${DEFAULT_BUILD_LOG_PASSWORD}'." + # fi + + # pushd build/logs && zip -e -P "$BUILD_LOG_ZIP_PASSWORD" ../../encrypted-test-logs.zip * || popd + # echo "::set-output name=encrypted::true" + + # - name: Upload encrypted-test-logs.zip + # id: attach-encrypted-test-log + # if: always() && steps.encrypt-test-log.outputs.encrypted == 'true' + # uses: actions/upload-artifact@v4 + # with: + # name: encrypted-test-logs-${{ github.sha }}.zip + # path: encrypted-test-logs.zip + + # - name: Print test-recording.log contents (if exists) + # if: ${{ always() && env.RECORD_PID != '' }} + # run: | + # if [ -f test-recording.log ]; then + # echo "test-recording.log found. Its contents:" + # cat test-recording.log + # else + # echo "test-recording.log not found." + # fi + + # - name: Check for test-recording.mp4 presence + # id: check-recording + # if: ${{ always() && env.RECORD_PID != '' }} + # run: | + # if [ -f test-recording.mp4 ]; then + # echo "::set-output name=found::true" + # echo "test-recording.mp4 found." + # else + # echo "test-recording.mp4 not found, skipping upload." + # echo "::set-output name=found::false" + # fi + + # - name: Upload test-recording.mp4 + # id: upload-recording + # if: ${{ always() && steps.check-recording.outputs.found == 'true' }} + # uses: actions/upload-artifact@v4 + # with: + # name: test-recording-${GITHUB_SHA:0:7}.mp4 + # path: test-recording.mp4 + + # - name: Zip test-results + # run: zip -r -9 ./test-results.zip ./build/tests + + # - name: Upload Test Artifacts + # uses: actions/upload-artifact@v4 + # with: + # name: test-results-${GITHUB_SHA:0:7}.zip + # path: test-results.zip + + deploy: + name: Deploy SideStore - ${{ inputs.release_tag }} + runs-on: macos-15 + needs: [serialize, build] + # needs: [serialize, build, test] + steps: + - name: Download IPA artifact + uses: actions/download-artifact@v4 + with: + name: SideStore-${{ needs.build.outputs.version }}.ipa + + - name: Download dSYM artifact + uses: actions/download-artifact@v4 + with: + name: SideStore-${{ needs.build.outputs.version }}-dSYMs.zip + + - name: Download encrypted-build-logs artifact + uses: actions/download-artifact@v4 + with: + name: encrypted-build-logs-${{ needs.build.outputs.version }}.zip + + - name: Download beta-build-num artifact + if: ${{ inputs.is_beta }} + uses: actions/download-artifact@v4 + with: + name: beta-build-num-${{ needs.build.outputs.version }}.zip + - name: Un-Zip beta-beta-build-num & update_apps.py + run: | + unzip beta-build-num.zip -d . + + + - name: List files before upload + run: | + echo ">>>>>>>>> Workdir <<<<<<<<<<" + find . -maxdepth 4 -exec ls -ld {} + || true # List contents if directory exists + echo "" + - name: Get current date id: date run: echo "date=$(date -u +'%c')" >> $GITHUB_OUTPUT @@ -377,9 +580,6 @@ jobs: id: date_altstore run: echo "date=$(date -u +'%Y-%m-%d')" >> $GITHUB_OUTPUT - - name: Create dSYMs zip - run: zip -r -9 ./SideStore.dSYMs.zip ./SideStore.xcarchive/dSYMs/* - - name: Upload to releases uses: IsaacShelton/update-existing-release@v1.3.1 with: @@ -400,14 +600,11 @@ jobs: Built at (UTC): `${{ steps.date.outputs.date }}` Built at (UTC date): `${{ steps.date_altstore.outputs.date }}` Commit SHA: `${{ github.sha }}` - Version: `${{ steps.version.outputs.version }}` + Version: `${{ needs.build.outputs.version }}` - # save it - name: Publish to SideStore/beta-build-num if: ${{ inputs.is_beta }} run: | - rm SideStore/beta-build-num/build_number.txt - mv build_number.txt SideStore/beta-build-num/build_number.txt pushd SideStore/beta-build-num/ echo "Configure Git user (committer details)" @@ -416,7 +613,7 @@ jobs: echo "Adding files to commit" git add --verbose build_number.txt - git commit -m " - updated for ${{ inputs.release_tag }} - $SHORT_COMMIT deployment" || echo "No changes to commit" + git commit -m " - updated for ${{ inputs.release_tag }} - ${{ needs.serialize.outputs.short-commit }} deployment" || echo "No changes to commit" echo "Pushing to remote repo" git push --verbose @@ -451,15 +648,17 @@ jobs: # Format localized description LOCALIZED_DESCRIPTION=$(cat <> $GITHUB_ENV echo "BUNDLE_IDENTIFIER=${{ inputs.bundle_id }}" >> $GITHUB_ENV - echo "VERSION_IPA=$MARKETING_VERSION" >> $GITHUB_ENV + echo "VERSION_IPA=${{ needs.build.outputs.version }}" >> $GITHUB_ENV echo "VERSION_DATE=$FORMATTED_DATE" >> $GITHUB_ENV + echo "RELEASE_CHANNEL=${{ needs.build.outputs.release-channel }}" >> $GITHUB_ENV echo "SIZE=$IPA_SIZE" >> $GITHUB_ENV echo "SHA256=$SHA256_HASH" >> $GITHUB_ENV echo "DOWNLOAD_URL=https://github.com/SideStore/SideStore/releases/download/${{ inputs.release_tag }}/SideStore.ipa" >> $GITHUB_ENV @@ -478,10 +677,10 @@ jobs: if: ${{ inputs.is_beta && inputs.publish }} uses: actions/checkout@v4 with: - repository: 'SideStore/apps-v2.json' - ref: 'main' # this branch is shared by all beta builds, so beta build workflows are serialized - token: ${{ secrets.CROSS_REPO_PUSH_KEY }} - path: 'SideStore/apps-v2.json' + repository: 'SideStore/apps-v2.json' + ref: 'main' # this branch is shared by all beta builds, so beta build workflows are serialized + token: ${{ secrets.CROSS_REPO_PUSH_KEY }} + path: 'SideStore/apps-v2.json' # for stable builds, let the user manually edit the source.json - name: Publish to SideStore/apps-v2.json @@ -500,7 +699,7 @@ jobs: # Commit changes and push using SSH git add --verbose ./_includes/source.json - git commit -m " - updated for $SHORT_COMMIT deployment" || echo "No changes to commit" + git commit -m " - updated for ${{ needs.serialize.outputs.short-commit }} deployment" || echo "No changes to commit" git push --verbose popd