[CI] Builder를 Github Action에 적용하기

 

💬 builder가 왜 필요한가

요모조모 프로젝트를 진행할때, 역시나 갓듀나가 builder를 github action에 적용해놨었다. 빌드테스트를 해본다구? 이게 무슨의미징!!! 생각했었다. 그냥 local에서 잘 돌아가면 되는거 아녀?

하지만,, 해당 builder의 역할은 엄청났다. 프로젝트가 깨질뻔한 여러번의 위기에서 날 구해주었다. help…

[Github] git conflict 해결! (feat. fork🍴) 필요할땐 수동으로 코드를 추가해주자

[Github] git conflict 해결! (feat. fork🍴) 필요할땐 수동으로 코드를 추가해주자

이러한 충돌들도, 전부 builder가 빌드 안된다고 알려주고 merge를 막아준 충돌들이다. 여러사람과 협업하다보면, 다양한 코드가 바뀌게 되면서 내 local에서는 빌드가 되었는데 develop 브랜치에 내 코드가 올라가는 순간! 프로젝트가 깨져버리는 경우가 생긴다. (대표적으로 내 두번재 프로젝트 ㅠㅠ 이때 빌더가 자동으로 검토해줬더라면,,얼마나 안전했을까!)

이런 경우들을 대비하기 위해서 builder는 꼭 필요한 것 같다. 물론, 마구잡이로 merge 하기 이전에 내 브랜치로 develop을 받아와서 build가 되는지 한번 더 테스트해보면서 안전하게 merge하는 습관이 더 필요하다. 하지만 이것을 자동으로 한번 더 검증해주는 것은 좋은거니까??? 그니까 빌더 적용 가보자고 - 🔥

🟣 builder.yml 파일 생성

우선, 이전에 작성했던 lint action과 동일하게 아래 파일 경로에다가 .yml 파일을 생성해준다.

.github/workflows/

🔖 builder.yml 파일 내용

name: DongSik-e Swift-Builder

on:
  push:
    branches: [ develop, main ]
  pull_request:
    branches: [ develop, release, hotfix ]

# workflow의 실행은 하나 이상의 job으로 구성
# 지금 이 workflow는 build라는 single job으로 구성
jobs:
  build:
    # job이 실행될 환경: macos - 가장 최신버전
    runs-on: macos-latest
    
    # step은 job의 일부, 실행될 task를 의미
    steps:
    # uses 키워드를 통해서 action에서 기본적으로 제공하는 액션을 사용하도록 함
    - name: 👻Checkout Source Code👻
      uses: actions/checkout@v2
          
    - name: 🍚 Start DongSik-e build 🛠
      run: |
        xcodebuild clean test -project ./DongSik-e/DongSik-e.xcodeproj -scheme DongSik-e -destination "platform=iOS Simulator,OS=16.0,name=iPhone 14 Pro" 
        xcpretty --color --simple

 

💬 설명을 조금 덧붙여볼게유. (주석에 적어놓긴함..)

우선 이쯤되면 yml파일에 대한 설명이 더 더덛 자세하게 필요할 것 같다. ㅋㅋㅋㅋㅋ 일단 builder 내부 코드에 대한 설명만 조금 하자면,

1️⃣ name / on

name: DongSik-e Swift-Builder

on:
  push:
    branches: [ develop, main ]
  pull_request:
    branches: [ develop, release, hotfix ]
 

• 해당 workflow 의 이름을 정해주었다.
• on 부분에는, 어떤 이벤트가 발생했을때 해당 builder파일을 돌려줄 것인지 정해줄수있다. 나는 main 브랜치와 develop브랜치에 push가 일어나면 해당 빌더를 돌려줄 것이고, develop, release, hotfix 브랜치에서 PR이 날라오면 빌더를 돌려줄 것이다.

2️⃣ jobs

workflow의 실행은 하나 이상의 job으로 구성되어있다. 지금 이 workflow는 build라는 workflow 하나로만 이루어져있는 single job으로 구성되어있다!

3️⃣ build

jobs:
  build:
    # job이 실행될 환경: macos - 가장 최신버전
    runs-on: macos-latest
    
    # step은 job의 일부, 실행될 task를 의미
    steps:
    # uses 키워드를 통해서 action에서 기본적으로 제공하는 액션을 사용하도록 함
    - name: 👻Checkout Source Code👻
      uses: actions/checkout@v2

• runs-on : 어떤 환경에서 실행시킬것인지 정해준다. 나는 macos 가장 최신버전에서 실행시켜줄 것이다.
• steps: 여기다가 github 내부에 있는 action을 사용할 것이라고 알려준다.
• actions/checkout@v2 는 이 레포지토리에 체크아웃하겠다는 뜻이당.

4️⃣ run 부분

- name: 🍚 Start DongSik-e build 🛠
      run: |
        xcodebuild clean test -project ./DongSik-e/DongSik-e.xcodeproj -scheme DongSik-e -destination "platform=iOS Simulator,OS=16.0,name=iPhone 14 Pro" 
        xcpretty --color --simple

• 여기서 빌드 테스트가 시작된다! 가장중요한건, run 내부에 있는 xcodebuild clean test -project ./DongSik-e/DongSik-e.xcodeproj -scheme DongSik-e -destination "platform=iOS Simulator,OS=16.0,name=iPhone 14 Pro" xcpretty --color --simple 이친구들
• xcodebuild clean test -project ./DongSik-e/DongSik-e.xcodeproj
  • 테스트를 진행할 xcodeproj파일의 경로를 알려주는 부분이다.
  • xcodeproj파일이 있는 위치를 잘 입력해준다. (만약 cocoapods를 이용해서 workspace파일을 이용한다면, workspace 파일 경로에 맞게 입력해주어야한다! 💁🏻)
• -scheme DongSik-e
  • 스키마 부분이 이해가 잘 되지 않았지만,,, 갓듀나의 설명에 의하면
  • 빌드를 진행하고 싶은 스키마를 입력해준다.
• -destination "platform=iOS Simulator,OS=16.0,name=iPhone 14 Pro"
  • 빌드를 진행할 iOS기기를 설정해준다.
  • 만약 OS의 가장 최신 버전에서 test를 해보려면, OS=latest 로 입력하면 된다. 나는 16.0에서 테스트해볼 것이다.
  • 테스트할 기기는 iPhone 14 Pro 이다!

 

🟣 자, 이제 PR을 날려보자.

yml파일을 적절한 경로에 만들어준 뒤, PR을 날려보자.

와 두근두근 빌더 돌아가는 소리 여기까지 들리네요!

---

🚨 빌더 적용 1차 실패 - 타겟이 문제인가?

역시나 실패할줄 알았다. 왜냐면!! 한번에 되면 그게 더 이상해~!~!~! ~! 해결해보자. 저 옆에 얄밉게 생긴 Details를 클릭해주자.

에러코드는 다음과 같다.

🚫 xcodebuild: error: Unable to find a destination matching the provided destination specifier:
{ platform:iOS Simulator, OS:16.0, name:iPhone 14 Pro }
The requested device could not be found because no available devices matched the request.

뭔가 타겟을 못찾는것 같다고 알려주는 것 같았다. 내가 지금 등록해준 destination이 없다는 건가? platform=iOS Simulator,OS=16.0,name=iPhone 14 Pro 현재 이렇게 설정되어 있는데, 이부분을 바꿔보자.

에러코드 바로 밑에 보면, Available destinations for the DonSik-e scheme 라고 친절하게 알려준다. 여기서 알려준 iOS기기 중 하나로 바꿔서 다시 돌려보자.

✅ 성공 잇힝! 🫶

이렇게 타겟을 16.2로 바꿔서 다시 커밋해주었다. pr이 이미 올라가있는 상태기 때문에 자동으로 빌더가 다시 돌아간다.

오래 돌아가는 거 보니,, 성공소리가 여기까지 들리네... 후 

올레!! 두번만에 성공했다. 근데,,,,, 왜 ... lint가 안돌아가지..? 하.... 

 

✨ 이제 스스로 액션을 적용할 수 있게 되었다!

yml파일이 다해주는 github action... CI에 대한 관심이 스믊스믈 올라오는 중이다. 넘나 편한걸..?
지금 근데 lint가 돌아가지 않아서, 추가적으로 더 테스트를 해보면서 뭐가 문제길래 action이 두개가 돌지 않는지 확인해보아야겠다. ㅠㅠㅠ 왜 안도는거야 lint!! 원래 두개가 돌아야 정상인데 말이다.. (이전에 lint action 적용하는 블로그글 보러가기!) 원인을 찾게된다면,, 블로그 글을 다시 업로드 해보겠다!!! 

builder는 특히 여러사람들과 협업할때 정말 중요한 기능일 것 같다. 지금은 혼자 진행하는 개인 프로젝트에 연습겸 적용해본 action인데 이제 다른 프로젝트에서 적용해봐야겠다! 화이팅. 

 

📚 참고 레퍼런스

https://github.com/DeveloperAcademy-POSTECH/MacC-Team-EarthValley80/discussions/5

[ARCHIVE] Github Action 단단히 알아가기 · Discussion #5 · DeveloperAcademy-POSTECH/MacC-Team-EarthValley80

https://github.com/DeveloperAcademy-POSTECH/MC2-Team3-SSAK3/blob/develop/.github/workflows/main.yml

GitHub - DeveloperAcademy-POSTECH/MC2-Team3-SSAK3: MC2-Team3-SSAK3 Repository