Migrate CircleCI 1.0 to CircleCI 2.0 (CI/CD for Android)

WindSekirun (wind.seo)·2022년 4월 26일

이 글은 기존 운영했던 WordPress 블로그인 PyxisPub: Development Life (pyxispub.uzuki.live) 에서 가져온 글 입니다. 모든 글을 가져오지는 않으며, 작성 시점과 현재 시점에는 차이가 많이 존재합니다.

작성 시점: 2017-11-01

CircleCI 2.0이 나온지 아마 3개월 정도 지났는데, 슬슬 1.0에서 올려야 될 타이밍인 것 같아서 CircleCI 1.0 에서 2.0으로 올리는 방법을 정리하려고 한다

1.0과 2.0의 차이점

기존 CircleCI 1.0에 비해 2.0은 이미 빌드되어 있는 Docker Image를 사용한다. 그와 동시에 캐시 기능도 확실히 제공하기 때문에 1.0에 비해 더 빠른 속도를 제공한다.

왼쪽이 1.0, 오른쪽이 2.0인데 확실히 봐도 속도가 빨라졌음을 알 수 있다.

마이그레이션 방법

기존 circle.yml 삭제

general:
    artifacts:
        - /home/ubuntu/RichUtilsKt/app/build/outputs/apk/

machine:
    environment:
        ANDROID_HOME: /usr/local/android-sdk-linux
        GRADLE_OPTS: '-Dorg.gradle.jvmargs="-Xmx2048m -XX:+HeapDumpOnOutOfMemoryError"'

dependencies:
    pre:
        - echo y | android update sdk --no-ui --all --filter tools,platform-tools,android-26
        - echo y | android update sdk --no-ui --all --filter build-tools-26.0.2
    override:
        - ANDROID_HOME=/usr/local/android-sdk-linux

compile:
    override:
       - (./gradlew dependencies):
                  timeout: 360

test:
    override:
        - (./gradlew test):
            timeout: 360

단 기존 환경 기준으로 API 26을 사용했다는 것 만큼은 기억해두고 지우자.

.circleci/config.yml 파일 생성

2.0에서 부터는 설정 파일이 .circleci 란 폴더 안에 config.yml 로서 존재하게 되었다.

version: 2
jobs:
  build:
    working_directory: ~/RichUtilsKt
    docker:
      - image: circleci/android:api-26-alpha
    environment:
      JVM_OPTS: -Xmx3200m
    steps:
      - checkout
      - run :
          name: display directory
          command: ls -la
      - restore_cache:
          key: jars-{{ checksum "build.gradle" }}-{{ checksum  "app/build.gradle" }}
      - run:
          name: Download Dependencies
          command: ./gradlew androidDependencies
      - save_cache:
          paths:
            - ~/.gradle
          key: jars-{{ checksum "build.gradle" }}-{{ checksum  "app/build.gradle" }}
      - run:
          name: Run Tests
          command: ./gradlew lint test
      - store_artifacts:
          path: app/build/reports
          destination: reports
      - store_test_results:
          path: richutils/build/test-results

조금 길은데, 하나씩 살펴보자.

version: 2.0 이므로 2를 적는다.
jobs: 시행할 작업을 나열할 곳이다.
working_directory: 작업이 실행될 장소. 보통 프로젝트의 루트 폴더명이다.
docker image: 이미 빌드되어 있는 안드로이드 이미지를 적어넣는다. Docker Hub에 따르면 api-23 부터 api-26 까지 있다. 만일 7.0이 대상이라면 api-25 를 적어넣으면 된다.
environment: 자바 힙 최대 용량을 3200mb로 설정한다.
steps: run, restore_cache, checkout, save_cache 등 문서상에 정의된 내용을 나열하는 곳이다.
checkout: git checkout. 더 이상 자세한 설명은 생략한다.
run : shell commend 를 실행하는 명령어이다. name 로는 CircleCI 페이지에 표시될 제목, commend 에는 실제 명령어를 작성한다.
restore_cache: 주어진 key 로부터 캐시를 불러오는 것이다. 여기서는 ./gradlew androidDependencies 까지를 캐시로 저장한다.
save_cahce: 주어진 경로를 캐시하는 기능이다.
store_artifacts: 빌드 리포트를 올리는 기능이다.
store_test_results: 테스트 결과 리포트를 올리는 기능이다.