Github Action을 이용한 Android CI/CD 구축 with Firebase

CI/CD란? 🤔

GitHub Actions는 개발자들이 코드 변경을 자동으로 빌드, 테스트, 배포할 수 있도록 도와주는 강력한 도구입니다.

이 글에서는 GitHub Actions의 기본 개념과 사용법을 소개하겠습니다.

 

지속적인 통합(Continuous Integration) -> CI

지속적인 배포(Continuous Delivery or Continuous Deployment) -> CD

 

GitHub Actions란? 🤔

GitHub Actions는 GitHub에서 제공하는 CI/CD 도구로, 다양한 이벤트(예: 코드 푸시, PR 생성 등)에 반응하여 워크플로우를 실행할 수 있습니다. 이를 통해 소프트웨어 개발 프로세스를 자동화하고 효율성을 높일 수 있습니다.

 

기본 구성 요소 🛠️

워크플로우(Workflow): 이벤트가 발생할 때 실행되는 작업의 집합입니다. YAML 형식으로 정의됩니다.

잡(Job): 워크플로우 내에서 실행되는 작업의 단위입니다. 여러 개의 잡을 병렬로 실행할 수 있습니다.

스텝(Step): 잡 내에서 실행되는 개별 명령어 또는 스크립트입니다.

액션(Action): 재사용 가능한 코드 조각으로, GitHub Marketplace에서 다양한 액션을 찾아 사용할 수 있습니다.

 

간단한 워크플로우 예제 📄

다음은 코드 푸시 시 자동으로 테스트를 실행하는 간단한 워크플로우 예제입니다.

name: CI

on:
  push:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - name: 체크아웃 코드
        uses: actions/checkout@v2

      - name: 노드 설치
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: 의존성 설치
        run: npm install

      - name: 테스트 실행
        run: npm test

• on: 어떤 이벤트에 반응할지를 설정합니다. 여기서는 main 브랜치에 푸시할 때 실행됩니다.
• jobs: 실행할 잡을 정의합니다.
• steps: 각 잡에서 실행할 스텝을 나열합니다.

 

Android CI/CD 구축 🫡

Github.Secrets

외부에 노출되면 안되는 정보들을 Github에 올려두고 사용할 수 없으니 해당 기능을 사용해서 Github Action 동작 중 값들을 참조할 수 있게 해줘야 합니다.

 

LOCAL_PROPERTIES_CONTENT

Local에 있는 local.properties를 모두 복사하여 그대로 넣어주면 됩니다.

 

FIREBASE_APP_ID

Firebase Project -> 프로젝트 설정 -> 내 앱 -> 앱 ID (앱 닉네임 위에 위치)를 복사해서 넣어주시면 됩니다.

 

GOOGLE_SERVICE_JSON

Firebase Project 추가 시 다운로드 받을 수 있는 google-services.json의 내용을 복사하여 그대로 넣어주시면 됩니다.

 

KEYSTORE_BASE64

keystore.jks를 생성했다는 가정하에 해당 해당 파일의 위치한 장소에서 터미널을 통해 아래 명령을 수행하면 base64로 인코딩된 keystore 값을 얻을 수 있습니다. 해당 값을 복사하여 그대로 넣어주시면 됩니다.

openssl base64 -in ./keystore.jks -out ./keystore.txt

 

 

CREDENTIAL_FILE_CONTENT

해당 값은 아래 링크를 참고해주세요.

ServiceCredentialsFileContent 생성 방법 (Github)

FIREBASE_TOKEN migration

 

최종 코드

Firebase Distribution을 통해 테스터에게 빌드된 앱을 빠르게 제공하기 위한 코드로,

빌드 시 workflow 번호가 App의 VersionCode로 설정되도록 했습니다.

이렇게 하면 특별한 일이 없이 없다면 고유한 버전 코드를 가질 수 있습니다.

 

추가로 해당 코드의 path들은 각 프로젝트에 맞게 수정해야 합니다!

아래는 Repository 루트에 프로젝트가 폴더 형태로 존재하는 구조임을 말씀드립니다!

name: Versioning, Build And Deployment to Firebase App Distribution
on:
  push:
    branches: [ develop ]
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    env:
      LOCAL_PROPERTIES_CONTENTS: ${{ secrets.LOCAL_PROPERTIES_CONTENTS }}
      GOOGLE_SERVICES_JSON: ${{ secrets.GOOGLE_SERVICES_JSON }}
      VERSION_CODE: ${{ github.run_number }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up JDK 17
        uses: actions/setup-java@v4
        with:
          distribution: 'corretto'
          java-version: '17'

      - name: Grant execute permission for gradlew
        run: chmod +x ./3days/gradlew

      - name: Create google-services.json
        run: echo "$GOOGLE_SERVICES_JSON" > ./3days/app/google-services.json

      - name: Create local.properties
        run: echo "$LOCAL_PROPERTIES_CONTENTS" > ./3days/local.properties

      - name: Decode and save keystore
        run: echo "${{ secrets.KEYSTORE_BASE64 }}" | base64 --decode > ./3days/app/keystore.jks

      - name: Verify keystore
        run: |
          ls -alh ./3days/app/
          echo "Checking JKS format..."
          keytool -list -v -keystore ./3days/app/keystore.jks -storetype JKS || echo "JKS format verification failed"

      - name: Build release APK
        run: |
          cd ./3days
          ./gradlew assembleRelease -PversionCode=$VERSION_CODE

      - name: Upload to Firebase App Distribution
        uses: wzieba/Firebase-Distribution-Github-Action@v1
        with:
          appId: ${{ secrets.FIREBASE_APP_ID }}
          serviceCredentialsFileContent: ${{ secrets.CREDENTIAL_FILE_CONTENT }}
          groups: 3days-tester
          file: ./3days/app/build/outputs/apk/release/3days-release.apk

 

트리거는 develop 브랜치에 push 했을 때 수행.

+ 수동으로 동작시키기 위한 workflow_dispatch

workflow_dispatch를 추가하면 Github Action에서 develop 브랜치에 push 하지 않더라도 수동으로 실행시킬 수 있음

 

우선 순서를 정리하자면,

1. 코드 체크아웃

2. JDK Setup

3. gradlew 권한 허용

4. google-services.json 파일 생성

5. local.properties 파일 생성

6. keystore 디코드 & 파일 생성

7. 생성된 keystore 파일 verify (가끔 인코딩을 잘못하고 진행하는 경우가 있어서 확인을 위해 추가, 크게 필요하지는 않음)

8. APK 빌드

9. Firebae Distribution

 

여기에 test, lint check 등의 작업을 추가할 수 있다. 

 

build.gradle(app)

val properties = gradleLocalProperties(rootDir, providers)

android {
    ...
    defaultConfig {
        ...
        // VersionCode = workflow Number
        versionCode = if (project.hasProperty("versionCode")) {
            project.property("versionCode").toString().toInt()
        } else {
            1
        }
    }

    // APK 파일명 설정
    applicationVariants.all {
        outputs.all {
            val outputImpl = this as com.android.build.gradle.internal.api.ApkVariantOutputImpl
            val newFileName = "3days-${name}.apk"
            outputImpl.outputFileName = newFileName
        }
    }

    // Signing Configs 설정
    signingConfigs {
        create("release") {
            keyAlias = properties["SIGNED_KEY_ALIAS"] as String?
            keyPassword = properties["SIGNED_KEY_PASSWORD"] as String?
            storeFile = properties["SIGNED_STORE_FILE"]?.let { file(it) }
            storePassword = properties["SIGNED_STORE_PASSWORD"] as String?
        }
    }

    // Build Types 설정
    buildTypes {
        release {
            signingConfig = signingConfigs.getByName("release")
            ...
        }
    }
    buildFeatures {
        buildConfig = true
    }
    ...
}

 

Path들만 자신의 프로젝트에 맞게 잘 수정한다면 쉽게 CI/CD 구축이 가능합니다!

 

🎉 결론

이제 GitHub develop Branch에 코드를 푸시하면, GitHub Actions가 자동으로 빌드를 수행하고 Firebase Distribution을 통해 테스터에게 APK를 배포합니다. CI/CD를 통해 효율적인 개발과 배포가 가능해집니다. 🚀