GitHub Actions에서 CMake로 C++ 코드 빌드하기(Feat. Boost 라이브러리)

· by 박승재

GitHub Actions는 GitHub에서 제공하는 작업 자동화 서비스로 반복적인 작업을 자동화할 수 있습니다.

이 글에서는 GitHub 저장소의 C++ 코드를 자동으로 빌드하는 예시를 보여줍니다.

작업 정의

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest

ubuntu-latest는 ubuntu-18.04과 동일합니다.

참고: Virtual environments for GitHub-hosted runners

C++ 코드 가져오기

steps:
  - name: Checkout sources
    uses: actions/checkout@v2

Git Submodules를 사용하고 있다면 submodules: recursive 옵션으로 코드를 가져올 수 있습니다.

steps:
  - name: Checkout sources
    uses: actions/checkout@v2
    with:
      submodules: recursive

참고: Checkout V2

선택: 의존성 다운로드

- name: Install dependencies
  run: |
      sudo apt-get update
      sudo apt-get install libjsoncpp-dev

위는 JsonCpp를 다운로드하는 예제입니다.

Ubuntu 18.04.4 LTS를 참고해 GitHub에서 제공하는 운영체제에 프로그램이 이미 설치되었는지 먼저 확인해봅니다.

Boost 라이브러리(1.69.0|1.72.0)의 경우 이미 설치되어 있기 때문에 다시 설치할 필요가 없습니다.

C++ 코드 빌드

- name: Run CMake
  run: |
      cmake -S . -B build
      cmake --build build -j 2

GitHub Actions는 2-core CPU를 제공하기 때문에 -j 2로 빌드 속도를 높일 수 있습니다.

참고: How to build a project with CMake

선택: Boost 라이브러리 포함해 빌드

GitHub Actions은 Boost 라이브러리 설치 위치를 각각 $BOOST_ROOT_1_69_0와 $BOOST_ROOT_1_72_0 변수로 제공합니다.

라이브러리 설치 위치가 수시로 변경되므로 /opt/hostedtoolcache/boost/1.72.0/x64 같이 경로를 하드코딩하지 말고 변수로 사용하길 권장하고 있습니다.

Boost 라이브러리를 include하기 위해서는 CMakeLists.txt 파일에서 아래와 같이 include_directories으로 라이브러리 헤더 파일을 가져옵니다.

# Boost headers only
find_package(Boost 1.66 REQUIRED)
include_directories(${Boost_INCLUDE_DIRS})

그리고 CMake에서 -DBoost_INCLUDE_DIR 옵션으로 직접 헤더 파일 경로를 입력해줘야 합니다.

헤더 파일은 $BOOST_ROOT_1_72_0/include에 있습니다.

(2020년 9월 21일 수정)

아래와 같이 BOOST_ROOT 환경변수를 만들어줘도 됩니다.

이때, set-env로 환경변수를 정의하는 작업과 CMake를 실행해 코드를 빌드하는 작업이 서로 다른 step으로 분리되어 있어야 합니다.

- name: Setup Boost environment variable
  run: echo "::set-env name=BOOST_ROOT::$BOOST_ROOT_1_72_0"
- name: Run CMake
  run: |
      cmake -S . -B build
      cmake --build build -j 2

참고: How can I include Boost 1.72.0 on ubuntu-latest?

(2021년 8월 1일 수정)

2021년 3월 8일부로 Boost 라이브러리가 저장공간 부족 문제로 OS 이미지에서 제거되었습니다.

따라서 Boost 라이브러리를 사용하기 위해서는 apt 등을 이용해 다운로드해줘야 합니다.

- name: Install dependencies
  run: |
      sudo apt-get update
      sudo apt-get install libboost-dev

- name: Run CMake
  run: |
      cmake -S . -B build
      cmake --build build -j 2

주의해야 할 점은 apt를 이용해 설치되는 Boost 라이브러리 버전은 1.71.0(수정일 기준)이기 때문에, 1.72.0 이상이 필요하다면 직접 라이브러리를 설치해야 합니다.

직접 라이브러리를 설치할 때는 cache 기능을 이용해 빌드 속도를 높일 수 있도록 합니다.

참고: Boost 1.72.0 will be removed from images on March, 8

전체 코드

name: C++

on:
  push:
    branches: [master]
  pull_request:
    branches: [master]

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest

    steps:
      - name: Checkout sources
        uses: actions/checkout@v2

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install libboost-dev

      - name: Run CMake
        run: |
          cmake -S . -B build
          cmake --build build -j 2