[iOS] fastlane을 이용해 배포 자동화하기

안녕하세요 제인입니다 :)

오늘은 프로젝트에 fastlane을 도입한 경험을 한번 공유해보려고 합니다!!

배포 자동화란?

먼저, 배포 자동화가 무엇인지부터 정리하고 넘어가겠습니다!

개발 공부를 하다보면 CI/CD라는 단어를 한번쯤 접해보셨을텐데요, 배포 자동화는 CD에 해당합니다.

CI/CD는 앱 개발 단계에 자동화를 통합하는 앱 제공 방식으로, 지속적 통합(Continuous Integration)/지속적 제공 또는 배포(Continuous Deployment 또는 Delivery)를 뜻합니다.

배포를 자동화 해야하는 이유?

그렇다면 배포 자동화는 왜 필요할까요?

당연히 배포를 자동화하지 않고, 수동으로 할 수도 있겠죠. 하지만, 수동으로 배포하는 과정은 시간도 오래 걸리고 번거롭습니다.

그리고 만약 이 과정에서 실수가 생긴다면 배포하는 데 걸리는 시간은 더 늘어나겠죠.

빈번한 배포가 이루어지는 서비스에서는 배포 룰을 한번 정해놓고 자동으로 배포 과정이 진행되도록 해서 배포에 드는 인풋을 줄이는 것이 효율성을 높이는 방법입니다. 

저의 경우, 기존 팀프로젝트에서 QA를 진행하거나 앱스토어 심사 제출 시 배포 과정이 번거롭고 시간도 많이 소요됨을 느꼈습니다.

심사에 필요한 빌드 제출 시, 테스트플라이트에 베타 버전을 배포해서 이를 심사에 포함시켜야 합니다.

베타 버전 배포의 과정은 앱 Achive - 업로드할 앱 버전 선택 - 배포 방식 선택 - 여러가지 옵션 선택 - 슬랙으로 팀원들에게 노티하기 .. 등 의 과정으로 진행되는데 이 과정이 저에게는 매우 번거롭게 느껴졌습니다. (심지어 시간도 최소 10여분 걸립니다..) 

 

그리고 해당 프로젝트는 개인 프로젝트 였기에 기획부터 배포까지 모든 일을 혼자 해야했기에 

배포를 자동화해서 기능 구현 및 코드 품질을 높이는 일에 더 시간을 많이 사용할 수 있도록 하기 위해 fastlane이라는 도구를 이용해서 배포를 자동화하게 되었습니다.

fastlane

공식문서에 따르면, fastlane은 iOS 및 Android 개발자가 스크린샷 생성, 프로필 프로비저닝 처리, 애플리케이션 출시와 같은 지루한 작업을 자동화할 수 있는 도구입니다.

 

🔽 fastlane 공식문서

https://docs.fastlane.tools/

fastlane docs

즉, fastlane은 iOS와 Android에서 배포를 자동화할 수 있도록 해주는 도구입니다.

fastlane으로 배포 자동화하기

1. fastlane 설치

먼저, 설치부터 해야겠죠? 저는 HomeBrew 를 이용해 설치를 해주었는데요, 아래 명령어로 쉽게 설치할 수 있습니다.

 

brew install fastlane

HomeBrew로 fastlane 설치하기

추가로, fastlane을 업데이트해야 한다면 bundler라는 프로그램을 이용하면 됩니다.

 

gem install bundler

 

bundler는 위의 명령어를 통해 설치할 수 있으며, 업데이트 시에는 bundle update 만 입력하면 됩니다.

2. fastlane 기본 설정

fastlane을 이용해 자동 배포 설정을 하기 위해서는 사용할 Xcode 프로젝트가 있는 경로로 이동해주세요! 

그런 다음 아래의 명령어로 기본 설정을 시작할 수 있습니다.

 

fastlane init

fastlane init

위의 스크린샷을 보면, Xcode 프로젝트 파일이 없는 곳에서 init할 경우, sub 디렉토리로 이동해서 진행하라는 오류가 뜨는 것을 확인할 수 있습니다. .xcodeproj 파일이 있는 디렉토리로 이동해서 한번 더 명령어를 입력하면 fastlane 폴더가 잘 생성되게 됩니다.

 

그 다음으로 어떤 작업을 할지 묻는 메세지가 나오게 됩니다. 

저는 테스트나 심사에 필요한 testflight beta 버전을 자동으로 배포하고 싶어서 2번을 선택해주었습니다. (이제 서비스 릴리즈도 완료되었으니 App Store에 자동으로 배포되도록 세팅도 한번 해봐야겠어요!)

그러면 프로젝트 파일 검사, 패키지 의존성 체크 등등 여러가지 작업을 하게 됩니다.

완료가 되면, Apple ID로 로그인 해달라고 뜹니다!
요구대로 애플 계발자 계정의 이메일과 비밀번호를 입력하고, 이중인증 6자리 코드도 입력하면 됩니다. (입력된 로그인 정보는 맥의 키체인 내에 저장된다고 합니다.)

위와 같은 메시지가 뜨면 기본적인 fastlane 설정은 완료되었습니다.
이제 해당 폴더에 아래와 같은 4가지 파일이 생성되었을 거에요!

• Gemfile
• Gemfile.lock
• fastlane/Appfile
• fastlane/Fastfile

3. 배포 설정

생성된 파일을 가지고 배포에 필요한 여러가지 설정을 할 수 있습니다.

여기서 배포에 필요한 설정을 하기 위해 수정해야 할 파일은 Appfile과 Fastfile입니다.

 

• Appfile: ID, Identifier 등 배포에 필요한 필수적인 값 설정
• Fastfile: 자동화 할 배포 룰 설정

Appfile

Appfile에는 Apple ID 또는 애플리케이션 Bundle Identifier와 같은 모든 fastlane 도구에 사용되는 유용한 정보가 저장되어 있어 프로젝트 요구 사항에 맞도록 더 빠르게 lane을 배치할 수 있습니다.

 

위에서 성공적으로 로그인했다면 이런식으로 기본 값들이 세팅될텐데,

만약 개인프로젝트가 아니라 팀프로젝트로 진행하며 여러 팀원들이 프로비저닝 파일 및 인증서를 공유해서 공동작업을 하게 된다면 apple_id 부분에서 잦은 충돌이 발생할 수 있습니다. 이런 경우에는 .env 파일을 이용해 환경변수로 설정하여 관리할 수 있습니다.

 

Fastfile

Fastfile에는 fastlane과 함께 실행할 수 있는 자동화 구성이 저장됩니다.

fastlane에 사용되는 여러가지 룰을 해당 파일에서 Ruby 언어로 작성할 수 있습니다.

default_platform(:ios)

platform :ios do
  desc "Push a new beta build to TestFlight"
  lane :beta do
    increment_build_number(build_number: latest_testflight_build_number + 1)
    build_app(scheme: "LuckyVicky")
    upload_to_testflight
    slack(
      message: "TestFlight 배포에 성공했습니다🍀",
      slack_url: "슬랙 webhookURL",
      payload: {
        "Build Date" => Time.new.to_s,
      },
      success: true
    )
  end
end

 

저의 경우, beta 버전이 정상적으로 testflight에 배포 완료되면, 슬랙에 노티까지 줄 수 있도록 설정해주었는데요!

코드는 위와 같습니다.

 

코드를 좀 살펴보자면,

default_platform(:ios)

기본 플랫폼을 iOS로 설정하여 fastlane [lane name]으로 간편하게 실행할 수 있습니다.

platform :ios do
  desc "Push a new beta build to TestFlight"
  lane :beta do
    ...
  end
end

기본 플랫폼 설정 코드 아래부터는 플랫폼에 관련된 모든 작업을 정의하는 블록입니다.

• desc "Push a new beta build to TestFlight": 이 lane의 설명을 작성합니다. 
• lane: [lane name] do ... end: lane의 작업 흐름을 정의합니다. beta lane은 TestFlight에 베타 빌드를 배포하는 과정을 자동화합니다.

제가 설정한 lane의 작업 흐름을 좀 더 자세히 볼게요!

increment_build_number(build_number: latest_testflight_build_number + 1)

 

현재 TestFlight에 올라가 있는 최신 빌드 번호를 가져오고, 빌드 번호를 1 증가시킵니다.

build_app(scheme: "LuckyVicky")​

 

지정된 scheme("LuckyVicky")을 사용하여 애플리케이션을 빌드합니다. 

해당 lane에 맞는 sheme을 지정해주면 되겠죠? (beta 버전에서는 debug, 실제 배포에서는 release 등)

upload_to_testflight
    slack(
      message: "TestFlight 배포에 성공했습니다🍀",
      slack_url: "슬랙 webhookURL",
      payload: {
        "Build Date" => Time.new.to_s,
      },
      success: true
    )

 

빌드된 애플리케이션을 TestFlight에 업로드하는 부분입니다. 

인증이 완료된다면 배포하고, 슬랙에 알림까지 주고 있습니다.

이슈 공유

 

저는 Fastfile을 수정하는 과정에서 한가지 이슈가 있었는데요, 요걸 한 번 공유해볼게요!

위와 같이 Fastfile을 잘 수정하고, fastlane beta 를 입력해 배포를 해보았는데요, 에러가 발생했습니다💥

에러를 살펴보면,

권한을 얻는데 실패했고, 23번 라인에서 에러가 나고 있고 ipa 파일을 업로드하는 데 실패했기 때문에 archive를 업로드 할 수 없다.

뭐 이런 오류가 나고 있네요.

 

fastlane 문서에 Authentication이라는 파트가 있어서 찾아보았습니다.

https://docs.fastlane.tools/getting-started/ios/authentication/

Authentication - fastlane docs

 

문서를 확인해보면, 가장 첫번째로 AppStore Connect API를 사용하라는 내용이 나옵니다.

문서에서 가이드해주는대로 App Store Connect > 사용자 및 액세스 > 통합 > App Store Connect API 에서 key 를 생성하고 json 파일을 만들어서 적용해주었습니다.

 

문서에서 매우 자세히 키 관리 방법까지 알려줍니다!

키 값은 민감한 정보이니 리모트에 올리지 않도록 주의해야 합니다.(저의 경우.gitignore에 파일 추가)

이렇게 이슈까지 해결한 최종적인 Fastfile 코드는 아래와 같습니다.

default_platform(:ios)

platform :ios do
  desc "Push a new beta build to TestFlight"
  lane :beta do
    increment_build_number(build_number: latest_testflight_build_number + 1)
    build_app(scheme: "LuckyVicky")
    upload_to_testflight(
      api_key_path: "fastlane/key.json"
    )
    slack(
      message: "TestFlight 배포에 성공했습니다🍀",
      slack_url: "https://hooks.slack.com/services/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",
      payload: {
        "Build Date" => Time.new.to_s,
      },
      success: true
    )
  end
end

 

이제 저장하고 fastlane beta를 입력해주면?!? 아래와 같이 성공 메시지가 뜹니다!

성공 메시지 확인

슬랙 메세지까쥐 성공!!

 

배포 자동화를 처음 해보는 것이라 설정 과정이 쉽지는 않았지만, 개인적으로 매우 만족하고 있습니다!

명령어 하나로 archive 부터 testflight에 올리는 것까지 자동으로 되니, 개발과정에만 집중할 수 있어 매우 편한 것 같습니다. 

급하게 심사를 올리거나, 테스트를 해보아야 할 때도 매우 유용한 것 같아요.

문서도 너무 잘 정리되어있어서 시도해볼만한 것 같습니다.

fastlane으로 배포 자동화를 시도해보시는 분들께 이 글이 조금이나마 도움이 되길 바랍니다🍀🍀

---

[참고 자료]

CI/CD란? - ServiceNow

fastlane docs

GitHub - fastlane/fastlane: 🚀 The easiest way to automate building and releasing your iOS and Android apps

iOS — 배포 자동화, Fastlane 시작부터 적용까지

[iOS] fastlane 이용한 배포 자동화 (TestFlight 편)