[iOS] Fastlane으로 앱 배포 자동화하기 - 이론과 설치

왜 Fastlane을 사용했을까?

다른 프로젝트를 진행하면서 이전에 진행한 프로젝트의 유지 보수를 맡고 있습니다. 유지 보수 중인 앱은 변경 사항이 많진 않지만 조금의 수정만으로 테스트를 위해 6개의 앱을 빌드하여 in house로 배포해야 했습니다. 그 후 QA를 거치게 되는데 이 기간 동안 변경 사항이 발생하거나 수정해야 할 부분이 있다면 다시 수정을 하고 6개의 앱을 빌드해서 배포해야 했어요. QA가 끝나면 엔터프라이즈 계정으로 다른 서버에 배포하게 됩니다. 

 

코드 수정이나 요구 사항은 적지만 조금의 수정으로 6개의 앱의 빌드(하는 것도 오래 걸림)와 배포하는 시간이 너무 오래 걸려서 진행하고 있는 프로젝트에도 영향이 오더라구요(여러개의 앱으로 분리하지 않기 위해 회의를 수십 번 했지만 안정성의 이유와 고객사의 이유로...큼큼)

 

직장 동료 분과 이야기해서 Xcode cloud를 사용해 보는 것이 어떻겠냐는 이야기를 들었고, 바로 Xcode Cloud에 대해 알아 보았습니다. 그러나 아래의 이유가 있어 Xcode cloud를 선택하지 않았습니다

- 유지 보수 및 운영에 투입된 인원이 iOS 팀에서 저 혼자였습니다 - 엔터프라이즈 계정으로 inHouse 배포 합니다  - 테스트 자동화를 적용하기 어려웠습니다. 앱의 특수성이 있는데요, 이 앱을 테스트 하기 위해서 직접 이 앱을 사용하고 있는 현장에 방문해야 합니다. 개발자가 아닌 기획자분이나 다른 업체의 서버 개발자분이 그곳으로 가서 테스트 하고 공유해 주십니다. (UI에 대해서는 UITest 코드를 작성할 수 있을것 같아 추후 개선해 보려 합니다.)

 

이러한 이유로 Xcode cloud를 사용할 수는 있겠지만 오버 스펙이라고 판단했고 좀더 단순한 과정이 필요했습니다

그때 발견한 것이 바로 Github Action. 메인 레포지토리에 코드를 푸시하면 수행할 일들을 스크립트에 작성할 수 있었습니다. Github Action을 보다가 Fastlane과 Github Action + Slack의 조합으로 CI/CD를 구현하는 글들을 발견하게 되었습니다. 

 

via GIPHY

앱을 빌드하고 아카이브 한 뒤 in House 서버에 자동으로 올리면 되겠다! 이거다 싶었습니다. 

혹시 CI/CD가 무엇인지 모르겠다면 👉🏻 2022.09.03 - [Swift Advanced] - [CI/CD] 지속적 통합과 지속적 배포의 개념과 장점

---

Fastlane 이란

출처 : fastlane

Fastlane은 앱을 빌드하고 테스트 플라이트 뿐만 아니라 앱스토어 업로드, 심사 제출, 테스터 초대 등을 자동화 할 수 있습니다. 심지어 플러그인을 사용할 수 있어서 iOS 앱 배포 자동화하기에 좋은 툴입니다. 여기에 Github Action을 사용한다면 레포지토리에 푸시하는 순간 트리거를 걸어 Fastlane을 실행할 수도 있어요! 

 

간단한 코드만으로 Slack과 연동도 되기 때문에 모든 과정이 다 끝난 뒤 슬랙으로 알림을 받아 볼 수 있습니다. 무료 툴이고 Ruby 언어 기반인데 걱정하실 필요 없습니다. 요런 느낌입니다.

이미 준비되어 있는 기능들을 조합하고 (없다면 플러그인을 설치해서) 순서를 설정해서 실행하면 됩니다. 스크립트를 작성해서 실행해 주면 됩니다. 

 

Setup

1. xCode command line

2. Homebrew

3. Ruby (brew install ruby)

4. Bundler

5. Fastlane (brew install fastlane)

6. Git (match에서 사용합니다)

 

터미널에서 명령어를 이용해 설치해 주시면 되는데, 저는 기존에 개발을 하면서 command line과 homebrew, Git이 깔려 있었어서 설치 전에 확인하세요!

 

1. xCode command line

xcode-select --install

 

 

2. Homebrew

Homebrew

기존에 Homebrew가 설치되어 있지 않다면 위 페이지에 접속해서 Homebrew를 깔아 줍니다. 

 

3. fastlane

document에서 제공하는 방식은 bundler을 이용해서 Fastlane을 설치하는 방식인데 brew를 이용해서 설치해 주도록 하겠습니다. 이때 꼭 Ruby를 따로 설치 하지 않아야 합니다. 

brew install fastlane

 

4. Bundler 

gem install bundler

gem은 ruby의 라이브러리 인데 gem을 이용하여 bundler를 설치해 줍니다. fastlane을 업데이트 할 때 사용 하는데 bundle update 혹은 brew upgrade fastlane을 사용해서 프로젝트 시작 전 fastlane을 업데이트 해주면 됩니다. 

 

필요한 툴을 다운로드 받았으니 fastlane을 시작해 봅시다

 

Fastlane

cd 명령어를 사용해서 iOS 프로젝트가 포함되어 있는 폴더로 이동해 줍니다. 

 

fastlane init

위 명령어를 입력하여 fastlane을 초기화 해줍니다. 

위 명령어를 입력 후 진행하게 되면 선택할 수 있는 옵션을 제시해 줍니다. 첫 번째 Screenshots은 말그대로 스크린샷입니다. 심사에 앱을 제출하거나 앱스토어에 보이는 스크린샷을 자동으로 찍어주는 기능입니다. 

TestFlight와 App Store 배포를 해야 한다면 2, 3을 선택하셔도 되지만 4번을 선택해서 2 와 3에 필요한 기능들을 정의해 줄 수 있습니다. 저는 in house 배포를 위해 4번을 선택해 주었습니다(여러 기능들이 포함되어야 한다면 4번을 추천드립니다. 2번과 3번은 앱 배포시에 필요한 애플 아이디와 비밀번호를 요구하게 되는데 한번 설정해 두면 배포시에 로그인이나 인증 과정이 필요 없습니다. 포스팅에는 4번 과정이므로 2, 3을 선택하게 되면 다른 화면이 나옵니다.)

 

모든 설정이 끝나고 나면 위와 같이 프로젝트 파일에 fastlane 폴더와 Gemfile이 생성됩니다.

Gem 은 위에서 설명했던 Ruby의 라이브러리 입니다. 협업을 위해 Gemfil에 Cocoapods 종속성을 관리할 수 있습니다.

fastlane 파일에는 두 개의 파일이 존재하는데 하나는 Appfile, 다른 하나는 Fastfile 입니다. 이 파일을 알아보기 전에 사이닝에 대해 잠시 알아볼게요!

 

Signing

가급적이면 유튜브로 튜토리얼을 참고 할 때 영어로 보려 하지만 너무 생소한 내용이면 한글 자막으로 보는데 자꾸 '빛나는'이란 단어가 나오더라구요. Signing을 Shining으로 자동 자막이 달리고 번역해서 빛난다고 나오는 것...

Fastlane의 엄청난 기능이자 장점은 인증과 사이닝, 그리고 Match라고 생각합니다.

Cert & Sign은 로컬이라고 생각하시면 되고 Match는 공유의 개념입니다. 

Cert & Sign

이름에서 유추할 수 있듯이 certificate와 Signing 입니다. 애플 계정을 입력해 두고 로컬 keychain을 이용해서 인증을 해주는 방식입니다. 로컬에 인증서가 없다면 자동으로 인증서와 프로비저닝 프로파일을 다운로드 받게 되는데 뭐.. 자동.. 네 그렇습니다 ..ㅠ 엔터프라이즈 배포 하시는 분들은 주의 하시기 바랍니다! 아래와 같은 이유 때문인데요, 

 

이미 앱이 배포 상태이고 여기에 Fastlane을 적용하시나요?

 

-> 앱 스토어에 이미 올라간 앱 : 이미 올린 상태이기 때문에 기존에 인증서와 프로파일을 revoke 하고 갱신한다고 해도 문제가 되지 않을 것입니다.

-> 테스트플라이트에 배포된 앱 : 인증서와 프로비저닝 프로파일을 revoke하고 갱신하는 순간 더 이상 사용하지 못합니다. 이 앱을 리뷰에 제출할 수도 없으므로 주의가 필요합니다. 

-> 엔터프라이즈에 배포한 앱 : 프로비저닝 프로파일을 갱신하는 순간 다운로드 받은 앱을 사용하지 못하게 되므로 주의가 필요합니다

 

Match

대규모의 팀에서 사용하는 방식이에요! 각 구성원 마다 다른 인증서를 사용하는 경우 관리가 어렵울 수 있습니다. Match는 private git repository에 certificate와 profile, private key를 올립니다. 그 후 팀원들이 Signing이 필요한 경우 이 레포지토리에 접근하여 매번 인증서를 가지고 와서 사용하는 방식입니다. 

만약 인증서가 만료되더라도 레포지토리의 인증서만 갱신해 주면 되기 때문에 관리가 용이한 방법입니다.

 

Appfile

Fastlane은 Appfile에 작성된 코드를 참고해서 특정 기능을 수행하게 됩니다. 따라서 여기에 app_identifier 즉, 번들 아이디와 애플 아이디, 팀 아이디를 지정해 주시면 됩니다. 

app_identifier("com.번들아이디")
apple_id("애플아이디로@사용한이메일.com")

이렇게 Appfile을 작성해 주시면 default로 작성해 준 번들아이디와 애플아이디를 사용하게 됩니다. 

app_identifier("번들아이디")
apple_id("애플아이디")

for_platform :ios do
    # 따로 지정하지 않은 경우 위에서 정의한 default 값 사용

    # release
    for_lane :{{lane 이름을 적어주세요}}
        app_identifier '해당 lane일 때 사용할 번들아이디'
    end
 end

혹은 이렇게 Fastfile에서 사용할 lane 별로 지정해 줄 수 도 있습니다.

(저의 경우 inHouse 배포였고 한 명의 개발자인 저 혼자 앱 운영을 맡고 있기 때문에 따로 cert & sign이나 match를 작성해 주지 않아 Appfile, Fastfile이 간단했습니다. 도움 받은 링크를 하단에 첨부해 두었으니 참고하시기 바랍니다! 추후에 위 부분에 대해서는 보완해서 따로 포스팅 하겠습니다)

 

Fastfile

fastlane의 기능들을 lane으로 정의해 줍니다. lane을 정의해 주면 그 lane을 실행 시키게 되고 lane의 기능들을 수행하게 됩니다. 사용 가능한 기능은 Fastlane 문서에 잘 정의되어 있습니다.

Available Actions - fastlane docs

해당 url로 확인하시면 테스팅, 빌딩, 스크린샷, 코드 사이닝, 앱 스토어 커넥트 등을 확인 할 수 있는데요, 이와 더불어 플러그인을 사용해서 슬랙 알림과 sftp, ftp에 파일 업로드도 가능합니다.

---

이번 포스팅에서는 Fastlane 설치와 Appfile를 간단하게 작성해 보았는데요, 다음 포스팅에서는 Fastfile을 작성해서 아카이빙, ipa 파일 업로드, 슬랙 알림에 대해 알아보겠습니다

부족하거나 이상한 점이 있다면 언제든지 댓글 부탁드립니다!

 

참고 사이트

https://ios-development.tistory.com/255

https://www.youtube.com/watch?v=90hJDqbUyqM&list=PLHchrqMOsMH4GjzlB3oVJmE6gTtXyZ-zQ&index=3

https://www.youtube.com/watch?v=Edr88s5YlH4&list=PLHchrqMOsMH4GjzlB3oVJmE6gTtXyZ-zQ&index=4