[Git & Github] Github Action으로 TestFlight 업로드 해보기(3)

안녕하세요~

 

오늘은 Github Action으로 TestFlight에 배포하는 과정의 마무리 포스팅이 될 것 같습니다 : )

 

[ 일단 지난 포스팅 - 사전 준비 ]

[Git & Github] Github Action으로 TestFlight 업로드 해보기(2)

 

yml 파일 수정

- Github 내에서 수정을 하셔도 되고 .github/workflows에 가시면 [정하셨던 이름].yml 과 같이 해당 파일이 존재하니 수정하시면 됩니다.

 

- 기존에 작성하셨던 yml 파일이 제 포스팅을 보셨다면 이렇게 정리되어 있을 거예요.

# Actions 탭에 표시될 Workflow 이름
name: CI

# Workflow를 실행시키기 위한 Event 목록
on: # 트리거
  # 하단 코드에 따라 develop 브랜치에 Push 또는 Pull Request 이벤트가 발생한 경우에 Workflow가 실행
  push:
    branches: [main]
	# 특정한 Branch에 푸쉬되었을 때 사용하려면 가령 feature/*로 작성하면 됨
  pull_request:
    branches: [main]

  # 해당 옵션을 통해 Actions 탭에서 Workflow를 실행
  workflow_dispatch:

# Workflow의 하나 이상의 Job 
jobs:
  # Job 이름으로, build라는 이름으로 Job이 표시
  build:
    # Runner가 실행되는 환경을 정의
    runs-on: macos-latest # iOS의 경우, 당연히 macOS에서 실행해야겠쥬~

    # build Job 내의 step 목록
    steps:
      # uses 키워드를 통해 Action을 불러옴
      # 여기에서는 해당 레포지토리로 check-out 및 레포지토리에 접근할 수 있는 Action을 불러옴.
      - uses: actions/checkout@v2
      # 실행되는 커맨드에 대한 설명으로, Workflow에 표시
      - name: Build
        run: echo Hello, world!

      # 하나의 커맨드가 아닌 여러 커맨드도 실행 가능
      - name: Run tests
        run: |
          # Xcodebuild를 통해서 해당 프로젝트를 테스트 할 수 있습니다!
          xcodebuild test -project "$XC_PROJECT" -scheme "$XC_SCHEME" -destination 'platform=iOS Simulator,name=iPhone 13'
          
          
# uses: Repository의 코드 복사본을 만드는 명령어
# name: 작업의 이름
# run: 컴파일러로 빌드하는 명령어

 

 

이제 지난 포스팅에서 준비했던 파일들을 스크립트 속에 넣어주면 마무리가 됩니다.

저희가 준비했던 파일들에는

DistributionCertificate, Distribution Provisioning Profile 이 있고

Password가 저장된 환경 변수들 ( secrets ) 이 있었죠.

 

1. 기본 세팅

name: TID Automation release

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: macos-latest

 

기본적으로 사용했던 코드입니다.

간단하게 알아보고 지나가볼게요.

 

해당 Action의 이름을 정하고

on 은 트리거 역할을 한다고 했었죠?

 

따라서 main이라는 branch에 Push 되었을 때

혹은 main이라는 branch에 PR이 왔을 때

 

두 가지 경우에 해당 Action이 실행된다는 뜻입니다.

 

개인 앱에서는 현재 [main] branch를 release로 사용하고 있기 때문에 다음과 같이 작성해뒀습니다.

여러분이 사용하고 계시는 배포용 브랜치에 적용하시면 될 것 같네요 : )

 

2. 가상 환경 설정

env: # 가상환경
      XC_VERSION: ${{ '13.1' }}
      XC_PROJECT: ${{ 'usket_TID.xcodeproj' }}
      XC_SCHEME: ${{ 'usket_TID' }}
      XC_ARCHIVE_PATH: ${{ 'usket_TID.xcarchive' }}
      KEYCHAIN: ${{ 'usket.keychain' }}
      
      ENCRYPTED_CERTS_FILE_PATH: ${{ '.github/secrets/GithubActionKey.p12.gpg' }}
      DECRYPTED_CERTS_FILE_PATH: ${{ '.github/secrets/GithubActionKey.p12' }} # 어디에 복호화 할 것인지 명시

      ENCRYPTED_PROVISION_FILE_PATH: ${{ '.github/secrets/GithubAction.mobileprovision.gpg' }}
      DECRYPTED_PROVISION_FILE_PATH: ${{ '.github/secrets/GithubAction.mobileprovision' }} # 어디에 복호화 할 것인지 명시

      CERTS_EXPORT_PWD: ${{ secrets.CERTS_EXPORT_PWD }}
      CERTS_ENCRYPTION_PWD: ${{ secrets.CERTS_ENCRYPTO_PWD }}
      PROFILES_ENCRYPTO_PWD: ${{ secrets.PROFILES_ENCRYPTO_PWD }}

 

여기서는 가상 머신에서 실행할 때 필요한 Xcode 및 기존에 생성했던 키체인과 환경변수 등을 설정해 줍니다.

XC로 시작하는 Xcode에 관한 설정들이 있고

KEYCHAIN과 기존에 암호화해 두었던 패스워드들을 등록하는 단계입니다.

 

3. Step ( 가상 환경에서 동작 )

일단 코드 전문부터 보여드리면 아래와 같습니다.

 

steps:
      - name: Setting checkout
        uses: actions/checkout@v3
          
      - name: Select Xcode Version
        run: "sudo xcode-select -s /Applications/Xcode_$XC_VERSION.app"

      - name: Configure Keychain 
        run: | 
          security create-keychain -p "" "$KEYCHAIN" 
          security list-keychains -s "$KEYCHAIN" 
          security default-keychain -s "$KEYCHAIN" 
          security unlock-keychain -p "" "$KEYCHAIN"
          security set-keychain-settings -lut 1200
          security list-keychains
          
      - name : Configure Code Signing
        run: | 
          gpg -d -o "$DECRYPTED_CERTS_FILE_PATH" --pinentry-mode=loopback --passphrase "$CERTS_ENCRYPTION_PWD" "$ENCRYPTED_CERTS_FILE_PATH"
          gpg -d -o "$DECRYPTED_PROVISION_FILE_PATH" --pinentry-mode=loopback --passphrase "$PROFILES_ENCRYPTO_PWD" "$ENCRYPTED_PROVISION_FILE_PATH"
          security import "$DECRYPTED_CERTS_FILE_PATH" -k "$KEYCHAIN" -P "$CERTS_EXPORT_PWD" -A
          security set-key-partition-list -S apple-tool:,apple: -s -k "" "$KEYCHAIN"
          mkdir -p "$HOME/Library/MobileDevice/Provisioning Profiles"
          echo `ls .github/secrets/*.mobileprovision`
          # 프로파일들을 rename하고 새로만든 디렉토리에 복사
          for PROVISION in `ls .github/secrets/*.mobileprovision`
            do
              UUID=`/usr/libexec/PlistBuddy -c 'Print :UUID' /dev/stdin <<< $(security cms -D -i ./$PROVISION)`
            cp "./$PROVISION" "$HOME/Library/MobileDevice/Provisioning Profiles/$UUID.mobileprovision"
            done
      - name: Archive App
        working-directory: usket_TID
        run: | 
          xcodebuild clean archive -project "$XC_PROJECT" -scheme "$XC_SCHEME" -configuration release -archivePath "$XC_ARCHIVE_PATH" 
          
      - name: Export App
        working-directory: usket_TID
        run:  |
          xcodebuild -exportArchive -archivePath "$XC_ARCHIVE_PATH" -exportOptionsPlist ExportOptions.plist -exportPath . -allowProvisioningUpdates
          ls
          
#       원래 사용해야하는 Github Action 오픈소스 	
#       - name: Upload app to TestFlight
#         uses: apple-actions/upload-testflight-build@v1
#         with:
#           app-path: 'usket_TID.ipa'
#           issuer-id: ${{ secrets.APPSTORE_ISSUER_ID }}
#           api-key-id: ${{ secrets.APPSTORE_API_KEY_ID }}
#           api-private-key: ${{ secrets.APPSTORE_API_PRIVATE_KEY }}

      - name: Install private API key P8
        env:
          APPSTORE_API_PRIVATE_KEY: ${{ secrets.APPSTORE_API_PRIVATE_KEY }}
          APPSTORE_API_KEY_ID: ${{ secrets.APPSTORE_API_KEY_ID }}
        run: | 
          mkdir -p ~/private_keys
          echo -n "$APPSTORE_API_PRIVATE_KEY" | base64 --decode --output ~/private_keys/AuthKey_$APPSTORE_API_KEY_ID.p8
          ls
          
      - name: Upload app to TestFlight
        env:
          APPSTORE_API_KEY_ID: ${{ secrets.APPSTORE_API_KEY_ID }}
        run: |
          cd usket_TID
          ls
          xcrun altool --output-format xml --upload-app -f usket_TID.ipa -t ios --apiKey $APPSTORE_API_KEY_ID --apiIssuer ${{ secrets.APPSTORE_ISSUER_ID }}

 

이제 하나씩 살펴보도록 하겠습니다.

 

(1) Github Action - checkout

- name: Setting checkout
  uses: actions/checkout@v3

 

Github Action에서 제공하는 checkout을 이용해 하위 작업들을 진행할 예정이기 때문에 필수적으로 들어가야 합니다.

 

(2) Xcode 설정

 - name: Select Xcode Version
   run: "sudo xcode-select -s /Applications/Xcode_$XC_VERSION.app"

 

앞서 만들어뒀던 변수를 넣어 해당 버전의 Xcode를 선택합니다.

 

(3) 키체인 설정

- name: Configure Keychain 
    run: | 
      security create-keychain -p "" "$KEYCHAIN" 
      security list-keychains -s "$KEYCHAIN" 
      security default-keychain -s "$KEYCHAIN" 
      security unlock-keychain -p "" "$KEYCHAIN"
      security set-keychain-settings -lut 1200
      security list-keychains

 

키체인을 생성하고 기존의 변수에 넣어주는 작업입니다.

 

여기서 security set-keychain-settings -lut 1200

이 커맨드는 키체인의 제한시간을 말하는데 저는 1200초로 설정해 두었습니다. 

여러분들도 일단 진행해 보고 타임아웃이 난다면 원하는 시간만큼 제한시간을 늘려주면 좋을 것 같습니다.

 

(4) Signing

- name : Configure Code Signing
    run: | 
      gpg -d -o "$DECRYPTED_CERTS_FILE_PATH" --pinentry-mode=loopback --passphrase "$CERTS_ENCRYPTION_PWD" "$ENCRYPTED_CERTS_FILE_PATH"
      gpg -d -o "$DECRYPTED_PROVISION_FILE_PATH" --pinentry-mode=loopback --passphrase "$PROFILES_ENCRYPTO_PWD" "$ENCRYPTED_PROVISION_FILE_PATH"
      security import "$DECRYPTED_CERTS_FILE_PATH" -k "$KEYCHAIN" -P "$CERTS_EXPORT_PWD" -A
      security set-key-partition-list -S apple-tool:,apple: -s -k "" "$KEYCHAIN"
      mkdir -p "$HOME/Library/MobileDevice/Provisioning Profiles"
      echo `ls .github/secrets/*.mobileprovision`
      # 프로파일들을 rename하고 새로만든 디렉토리에 복사
      for PROVISION in `ls .github/secrets/*.mobileprovision`
        do
          UUID=`/usr/libexec/PlistBuddy -c 'Print :UUID' /dev/stdin <<< $(security cms -D -i ./$PROVISION)`
        cp "./$PROVISION" "$HOME/Library/MobileDevice/Provisioning Profiles/$UUID.mobileprovision"
        done

 

기존에 GnuGP 보안 설루션을 이용해 gpg라는 커맨드로 암호화했던 것 기억하시나요?

gpg -d는 dectypt로 저희가 설정해 둔 Path로부터 암호를 받아 디코드하여 적용해 줍니다.

 

나머지 부분은 위의 암호들을 이용해 키체인을 생성하고 디렉터리에 복사해 주는 역할을 합니다.

 

(5) 아카이브 및 ipa파일 만들기

※ ipa는 iOS 앱 파일을 말합니다.

 

 - name: Archive App
    working-directory: usket_TID
    run: | 
      xcodebuild clean archive -project "$XC_PROJECT" -scheme "$XC_SCHEME" -configuration release -archivePath "$XC_ARCHIVE_PATH" 

  - name: Export App
    working-directory: usket_TID
    run:  |
      xcodebuild -exportArchive -archivePath "$XC_ARCHIVE_PATH" -exportOptionsPlist ExportOptions.plist -exportPath . -allowProvisioningUpdates
      ls

 

여기서 저 같은 경우에는 working-directory를 적어줬는데 

Github에 프로젝트 폴더의 상위 폴더에 git을 초기화하는 실수 때문에 적어줬습니다.

이 부분은 적지 않아도 괜찮아요 : )

 

이제 아카이빙을 진행하고 아카이브에서 ipa파일을 ExportOptions.plist를 이용해 만들어줍니다.

 

(6) TestFlight

저는 이 부분에서 오류가 나서 130번 정도 Action을 돌려가면서 오류를 찾고 해결했습니다 : (

 

일단 첫 번째 방법을 사용해 보시고 안된다 싶거나 저와 같은 오류가 있다면 사용해 보세요!

 

첫 번째 방법, Github Action 오픈소스 사용하기

코드 전문에 보면 주석 처리된 부분이 있던 것을 확인하셨을 텐데

바로 그 주석 부분을 사용하는 겁니다.

 

- name: Upload app to TestFlight
 uses: apple-actions/upload-testflight-build@v1
 with:
   app-path: 'usket_TID.ipa'
   issuer-id: ${{ secrets.APPSTORE_ISSUER_ID }}
   api-key-id: ${{ secrets.APPSTORE_API_KEY_ID }}
   api-private-key: ${{ secrets.APPSTORE_API_PRIVATE_KEY }}

 

만들어둔 ipa파일의 경로 및 저와 함께 설정했던 변수를 지정해서 돌려주면 바로 등록이 되실 거예요.

 

만약에 다음과 같이 오류가 나온다면

The file 'AuthKey_***.p8' could not be found in any of these locations

 

제가 겪었던 오류랑 같은 오류입니다. 

 

두 번째 방법, 제가 만들게요.

초기에 오류 메세지와 관련된 내용을 탐색하다 보니

Xcode 13 이상부터 발견되는 이슈인 것 같다는 내용이 있어

Xcode의 버전을 변경해봤지만 같은 오류가 발생했습니다.

 

추가적으로 Action 자체의 빌드 버전에 문제 있을수도 있다는 글이 있어

버전을 변경해가며 시도했지만 아쉽게도 이또한 동작하지 않았습니다.

 

p8이 뭔지부터 다시 알아봤습니다.

p8은 애플 개발자 계정에서 다운로드해 온 비공개 키를 말하는 것이었고

action에서는 이를 이용해 가상환경에서 앱스토어 커넥트 API를 사용하고 있었습니다.

즉, 입력했던 환경변수가 잘못되었을 가능성이 있었습니다. (APPSTORE_API_PRIVATE_KEY)

 

이런 저런 헛발질 도중

참고했던 개발 블로그에서 진행했던 base64 인코딩이 기억이 났고

이것이 문제의 원인일 것이라는 확신이 들었습니다.

 

인코딩된 키값을 그대로 사용하고 있었으며 경로도 작성하지 않았다는 것을 알게되었습니다.

 

결국 추가적인 스크립트 작성이 필요했습니다.

추가한 스크립트는 아래와 같습니다.

 

 - name: Install private API key P8
    env:
      APPSTORE_API_PRIVATE_KEY: ${{ secrets.APPSTORE_API_PRIVATE_KEY }}
      APPSTORE_API_KEY_ID: ${{ secrets.APPSTORE_API_KEY_ID }}
    run: | 
      mkdir -p ~/private_keys
      echo -n "$APPSTORE_API_PRIVATE_KEY" | base64 --decode --output ~/private_keys/AuthKey_$APPSTORE_API_KEY_ID.p8

  - name: Upload app to TestFlight
    env:
      APPSTORE_API_KEY_ID: ${{ secrets.APPSTORE_API_KEY_ID }}
    run: |
      cd usket_TID
      xcrun altool --output-format xml --upload-app -f usket_TID.ipa -t ios --apiKey $APPSTORE_API_KEY_ID --apiIssuer ${{ secrets.APPSTORE_ISSUER_ID }}

 

디렉토리를 생성하고 base64로 디코딩하여 저장한 이후 사용하는 것을 확인할 수 있습니다.

 

이 과정을 진행하고 나니 드디어 TestFlight에 성공적으로 업로드가 되었습니다 : - )

 

 

---

 

 

추후에는 테스트까지 진행하는 포스팅으로 찾아뵙겠습니다.

그럼 이만 👋🏻 👋🏻 👋🏻