[iOS] Fastlane을 통한 빌드/배포 자동화

오늘은 App Store로 앱을 배포하는 과정을 Fastlane을 통해 자동화 하는걸 해보고,

그 과정에서 만난 에러나 해결방법을 정리하려고 합니다!!

 

지금 제가 개발하는 서비스는 평균적으로 보면 한달에 1~2회 신규 버전을 출시 하는 것 같아요.

사실 배포하는 빈도도 그렇게 많지 않고, 그 과정이 많이 복잡한 것(?)도 아니라서..

딱히 불편하고 귀찮다고 생각을 안했던 것 같아요!

 

그런데.. 최근에 갑자기 자동화를 해야겠다, 라고 생각이 문득 들었는데요!

앱스토어에 앱을 배포하고, 업로드 완료되었다, 테스트 플라이트 배포되었다, 등등 테스터 조직에게 공유를 해야하죠.

근데 앱스토어에 업로드하고, 그 후에 내부적으로 처리하는 시간이 정해져있지 않고 가변적이죠~?

 

그럼 그때마다 모니터링 하면서 처리되는 과정을 들여다보고 있어야 하더라구요 ㅋㅋ

그걸 왜 번거로운 과정이라고 생각하지 않았었는지 😂

 

서두가 길어졌네요!! 

 

---

 

먼저 fastlane 공식 홈페이지에요! 이 가이드를 참고하면서 진행했습니다~!

docs.fastlane.tools/getting-started/ios/setup/

Setup - fastlane docs

 

기존에 우리가 수동으로 App Store에 앱을 배포하려면 어떻게 해야했죠~?

• 버전과 빌드를 올린다.
• 빌드하고, 필요시 cocoapods 를 업데이트하거나 인스톨한다.
• Analyze 실행하고 기다림
• Archive 실행하고 기다림
• Archive가 다 되면 App Store Connect 에 업로드
• TestFlight 출시, Slack에 업로드 및 배포가 완료되었음을 공유
• 준비가 완료되면 심사 요청, 심사 통과하면 업데이트 로그 작성후 스토어 출시

솔직히 수동으로 해도 막 번거로운 작업은 아닐거에요. 그래도 우리는 개발자잖아요~? 자동으로 하게끔 해야죠!!

위 과정중에 파란색으로 표시한 부분을 자동화 해볼거에요! 🤟

 

 

XCode Command Line Tool 설치

먼저 xcode Command Line Tools를 설치해야 되요.

만약 설치되어 있는 Xcode의 버전이 Beta버전이면,(혹은 Mac OS 버전 업그레이드 등의 다른 이유로) Command Line Tools이 설치되어 있지 않을거에요.

xcode-select --install

만약 설치되어 있지 않다면 위 명령어로 CLT를 설치해줍니다!

설치되어 있는 상태에서 실행해도 상관없어요. 이미 설치되어 있다고 알려줍니다! 👍

 

Fastlane 설치

다음은 fastlane을 설치해줍니다.

저는 Homebrew를 사용하기 때문에 아래 명령어로 설치했어요.

brew install fastlane

gem을 사용하는 등 다른 방법으로 설치하려면 홈페이지를 참고해보시기를 바래요~ 🙏

 

Fastlane Setting

설치가 완료되었으면, 프로젝트가 있는 루트디렉토리로 이동해서, 아래 명령어를 실행해주세요!

fastlane init

그럼 이렇게 어떤 작업을 자동화처리 하도록 만들래? 하고 보기를 줍니다.

저는 앱스토어에 배포하는 것까지 해보기로 했으니, 3번을 선택해주었어요.

 

여기서 저는 이런 에러를 만났어요.

Unable to locate Xcode. Please make sure to have Xcode installed on your machine

응..? Xcode가 설치안되어 있다고..!? 당황하지 않고 구글링 👉

Xcode Preference > Locations에서, Command Line Tools를 명시적으로 선택해주지 않은 경우에 마치 Xcode를 찾을 수 없는 것처럼 에러 메세지가 발생하더라구요!! 저는 이게 설정되어 있지 않았고, 현재 사용중인 버전으로 지정해주었어요!

 

그리고 다시 fastlane init 👉

오오~ 이번에는 에러를 안받고 통과했어요!! Apple 계정을 입력하라고 하네요.

로그인 잘 해주시구요~!! 중간에 app 에 대한 P/W를 설정해야 한다는 이유로 진행이 안되었는데, 그 화면은 캡쳐를 못해서 보여줄 수는 없네요 😭 대신 에러 메세지에 "app에 대한 P/W를 설정해야 하며, 설정하는 방법은 이러이러하다"라고 상세하게 나와있으니 천천히 읽어보시고 해보시길 바래요 🙏

 

설정하는 과정에서, 앱의 metadata를 fastlane을 통해 관리할건지 물어보네요!

저는 이건 관리하지 않기로 했어요. 여기서 y로 해봤더니, 앱스토어 업로드 과정에 metadata에 대한 미리보기를 보여주면서, 이대로 진행할까요? 라는 질문에 한번 응답을 해줘야 하는 귀찮은(?) 일이 발생합니다 😂

어차피 metadata는 앱 심사요청 하기 전에 한번 검토할거니까 괜찮을 것 같았어요!!

 

그리고 2~3번 세팅된 내용을 설명해주면서 엔터를 치라고 하면 엔터를 쳐줍니다.

세팅 완료~ 간단-🧑‍💻

 

Fastfile 수정하기

다시 프로젝트 루트 경로를 보면, fastlane이라는 디렉토리가 생겼을거에요.

default_platform(:ios)

platform :ios do
  desc "Push a new release build to the App Store"
  lane :release do
    increment_build_number(xcodeproj: "YOUR_PROJECT.xcodeproj")
    build_app(workspace: "YOUR_PROJECT.xcworkspace", scheme: "YOUR_PROJECT")
    upload_to_app_store
  end
end

fastlane 폴더에 들어가보면 Fastfile이 있는데  이런식으로 기본적인 Script 파일을 만들어줍니다.

script는 간략하게 설명하면 아래처럼 동작해요.

• lane :release do 👉 release라는 fastlane 명령어를 만들고, 이 명령어를 실행하면 아래의 동작을 수행해주세요.
• increment_build_number 👉 현재 빌드 버전에서 하나를 올려주세요.
• build_app 👉 앱을 빌드해주세요.
• upload_to_app_store 👉 앱스토어에 앱을 업로드해주세요.

쉽죠~?

Script에 대한 상세한 내용이나 추가로 사용할 수 있는 Method는 위에서 소개드린 공식 홈페이지에서 찾아볼 수 있어요.

 

그럼 배포해달라는 명령어를 만들었으니, 한번 배포를 해보죠!!

 

Fastlane으로 빌드, 배포하기

우리가 위에서 만들었던 release라는 명령어를 실행해볼게요.

fastlane release

뭔가 막 빌드되고 아카이빙되기 시작합니다!! 처음이니까(?) 한번 지켜봐줍니다 ㅋㅋ

별일 없이 마무리 되었고, 몇분 뒤에 App Store Connect에서 볼 수 있다고 하네요!! 👍

완료되면 이렇게 script에서 수행하도록 했던 Method들에 대한 수행시간 등등 전체적인 통계정보를 뿌려주면서 완료되네요!

그리고 잠시 기다려 보니, App Store Connect에 정상적으로 업로드 된 걸 볼 수 있었어요!! ㅎㅎ

 

 

오케이 좋아.. 근데 처음에 목표로 잡은 것과는 다르잖아..!?

저 업로드 되는 과정을 눈팅하지 않고 완료되면 알아서 Slack으로 공유해주기로 했잖아..!?

 

네! 그래서 지금부터는 Slack과 연동을 해볼거에요.

 

Fastlane 작업 수행 후 Slack으로 메세지 보내기

docs.fastlane.tools/actions/slack/

slack - fastlane docs

요즘은 협업 툴로 메신저는 아마 대부분 Slack을 사용할 거에요. 그래서 그런지..

이렇게 공식 홈페이지에서도 slack과 연동은 이렇게 하세요~ 하고 잘 설명되어 있네요 😎

 

위에서 fastlane/fastFile에서 명령어를 만들고 Script를 작성해줬던 것처럼 Slack 메세지를 보내도록 lane을 만들어 볼게요.

lane :send_slack do
    version = get_version_number(
	xcodeproj: "PROJECT_NAME.xcodeproj", 
	target: "PROJECT_NAME"
    )
    build = get_build_number(xcodeproj: "PROJECT_NAME.xcodeproj") 
    
    slack(
      message: "앱스토어 업로드가 완료되었습니다.",
      channel: "#fastlanetest",
      slack_url: "WEBHOOK_URL",
      default_payloads: [:lane, :test_result, :git_branch, :git_author],
      payload: {
	"Version": version + " (" + build + ")"
      }
    )
   end

띠용~ 걱정마세요!! 위에서 했던 것처럼 하나씩 살펴볼거에요.

• lane :send_slack do 👉 send_slack이라는 명령어를 만들고, 아래와 같은 동작을 수행할거에요.
• get_version_number 👉 앱의 버전을 가져오세요.
• get_build_number 👉 앱의 빌드번호를 가져오세요.
• slack() 👉 Slack 메세지를 구성해주세요. 내용은 ( ) 안에 있는 내용처럼요!
• message 👉 메세지 타이틀은 이렇게 해주세요.
• channel 👉 이 채널에 공유해주세요.
• slack_url 👉 이 채널의 url은 이거에요.
• default_payloads 👉 디폴트로 이런이런 정보를 넣어주세요. 
• payload 👉 추가로 이런 정보를 같이 보내주세요.

쉽..죠..!? 저는 어떤 버전, 어떤 빌드로 테스트할지 같이 공유하기 위해 버전과 빌드번호를 같이 전송하게끔 해줬어요.

get_version_number 이런 녀석들을 fastlane action 이라고 해요.

엄청 다양한 action이 있고, 상세한 내용은 공식홈페이지 여기에 잘 나와있답니다.

 

Slack 메세지를 구성하는 부분도 공식 홈페이지에 상세하게 설명이 있으니, 추가로 필요한건 찾아서 사용해도 좋겠네요 🧑‍💻

 

여기서 한가지, slack_url에 webhook URL을 입력해주면 되는데요~!

슬랙에서 특정 채널에 대한 webhook url은 어떻게 얻을까요~?

 

Slack 채널 webhook url 가져오기

먼저 슬랙에 공유할, 원하는 채널을 선택해주세요!

그리고 상단에 화살표에서, Administration > Manage apps를 선택해주세요!

 

그러면 슬랙에 추가할 수 있는 플러그인(?)들이 많이 보이는데, 검색을 통해서 Incoming Webhooks를 선택해줍니다.

바로 다음 화면에서 Add to Slack 👉

원하는 슬랙 채널 선택 👉

짜잔~ 그럼 이렇게 바로 webhook url을 생성해줍니다!

그리고 추가로 필요할 경우에 이런 저런 세팅을 해주고, 저장해줍니다.

 

여기서 만들어진 WebHook URL을 복사해서 아까 만들던 lane의 slack_url에 넣어줍니다.

그리고 lane을 만들었으니 실행해서 한번 메세지 보내보기!!

fastlane send_slack

오오옷~~~ 잘 옵니다!! 👍

 

그럼 이제 마지막으로, 우리가 release 명령어를 실행했을때 업로드가 완료되면 slack이 와야겠죠~~?

  lane :release do
    increment_build_number(xcodeproj: "PROJECT_NAME.xcodeproj")
    build_app(workspace: "PROJECT_NAME.xcworkspace", scheme: "PROJECT_NAME")
    upload_to_app_store(skip_metadata: true, skip_screenshots: true)
    send_slack
  end

이렇게!! 앱스토어 업로드용으로 만들었던 lane의 마지막에, 방금 만든 send_slack을 실행해주기만 하면 끝~~~👍

 

 

** 21/04/15 ** 내용 추가

지금 제가 개발하는 서비스의 경우엔, testflight로 내부테스트를 진행하고 앱을 출시하는데요!

포스팅에서는 Appstore에 앱이 업로드만 되면 슬랙으로 완료되었다고 메세지를 보내주었어요.

 

그치만 실제로 testflight에서 테스트하려면 앱스토어 내부적으로 처리하는 과정이 필요하고, 생각보다 긴 시간이 소요되요.

그 시간동안 쳐다보고 있다가, "업로드는 아까 됐는데 이제 처리가 됐네요~ 테스트해주세요~" 할 수는 없겠죠?ㅋㅋ

 

위에서 Fastfile에 작성했던 

upload_to_app_store(skip_metadata: true, skip_screenshots: true)

메소드를, 테스트 플라이트로만 변경해주면 끝이에요!

upload_to_testflight

이렇게 해주면, 앱스토어에서 내부적으로 처리하는 과정까지 완료되고 테스트 가능한 시점에 슬랙을 보내준답니다!! 👍

이 과정에서 앱스토어 업로드도 당연히 포함되니까, 저는 따로 앱스토어 업로드는 사용안해도 될 것 같아요!!

 

---

 

시작은 굉장한걸 하는 것 마냥 시도한 것 같은데, 막상 해놓고 나니 별거 없었던 것(?) 같네요. ㅋㅋ 🤟

앞으로도 이것 저것 시도하고 도입할만한 건 적극 시도해보고 싶네요 😎

 

오늘도 누군가에게 도움이 되었길 바래요 🙏