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

안녕하세요~

 

이번 포스팅에서는 Github Action에 대한 설명과 Github에서 어떻게 사용할 수 있는지 작성해보려고 합니다.

 

Github Action 이란?

- Github 저장소를 기반으로 소프트웨어 개발 Workflow를 자동화할 수 있는 도구입니다. Github 내부에서 프로젝트를 빌드, 테스트, 릴리즈 또는 배포를 지원하는 기능으로, Github에서 제공하는 CI/CD 도구라고 생각하면 편할 것 같네요.

 

그러면 어떻게 Github Action이 이루어져 있는지 확인해 보겠습니다.

 

Github Action의 구성요소

구성도(출처: https://ios-development.tistory.com/788 )

1. Workflow

- Repository에 추가할 수 있는 자동화 커맨드의 집합으로 하나 이상의 Job으로 구성되어 있으며 Push나 PR과 같은 이벤트에 의해 실행될 수도 있으며 특정 시간대에 실행될 수도 있습니다.

 

- 이름 그대로 그대로 작업의 흐름이라고 생각하면 좋을 것 같습니다.

2. Event

- Workflow를 실행시키는 특정 행동 ( Push, Pull Request, Commit 등 )을 의미합니다. 일종의 트리거라고 생각하면 좋을 것 같습니다.

3. Job

- Job이란 동일한 Runner에서 진행되는 Step의 집합을 의미합니다. ( 뒤에 Runner와 Step도 설명해 두겠습니다. )

 

- 하나의 workflow 내의 여러 Job은 독립적으로 실행되나 필요에 따라 의존 관계를 설정하여 순서를 지정할 수 있습니다.

 

- 가령 Test 작업과 Build 작업을 수행하는 Job들이 하나의 workflow에 존재한다면 Build 이후에 Test가 진행되어야 하기 때문에 Build Job이 마무리된 후 Test Job을 실행할 수 있도록 지정 가능합니다(Build 실패 시 Test는 실행하지 않는다는 뜻).  

 4. Step

- 커맨드를 실행할 수 있는 각각의 Task를 의미하고, Shell 커맨드가 될 수도 있고, 하나의 Action이 될 수도 있습니다.

- 하나의 Job 내에서 각각의 Step은 다양한 Task로 인해 생성된 데이터를 공유할 수 있습니다.

5. Action

- Job을 만들기 위해 Step을 결합한 커맨드로 재사용이 가능한 Workflow의 가장 작은 단위를 말합니다.

- 직접 만들거나 Github Community에 의해 생성된 Action을 불러와 사용할 수 있습니다.

6. Runner

- Runner란 Github Actions Workflow 내에 있는 Job을 실행시키기 위한 애플리케이션입니다.

- Runner Application은 Github에서 호스팅 하는 가상환경 혹은 직접 호스팅 하는 가상 환경에서 실행 가능하며 Github에서 호스팅하는 가상 인스턴스의 경우 메모리 및 용량 제한이 존재합니다.

 

Github Action 적용 방법

1. 상단의 메뉴 중 Action에 들어갑니다.

2.set up a workflow yourself를 클릭

3. 그러면 다음과 같이 yml파일을 만들 수 있게 화면이 나오게 됩니다.

 

앞서 설명드렸던 용어들이 보이네요 : ) 

 

Xcodebuild를 이용해 Test까지 해보는 코드로 작성하면 아래와 같습니다.

(주석으로 간단한 설명을 보충하겠습니다)

 

# 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: 컴파일러로 빌드하는 명령어

 

작성 이후 커밋 혹은 푸시를 하게 되면

Action에서 잘 작동했는지 문제가 없었는지 확인할 수 있을 겁니다 : ) 

 

4. 잘 동작했는지 확인!

빌드 이후 아래와 같은 이미지라면 작성한 Action이 잘 동작한 겁니다!

 

 

이렇게 간단하게 개념과 테스트 정도까지만 진행할 수 있게 알아봤습니다.

 

다음 포스팅에서는 TestFlight에 배포하는 과정과 제가 겪었던 이슈에 대한 트러블 슈팅을 정리해 보겠습니다 ~

 

그럼 이만 👋🏻 👋🏻

 

 

 

---

[ TestFlight에 배포하기 위한 준비운동 포스팅 🧑🏻‍💻 ]

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