1. CI가 어떻게 동작하는가?

앞에서 설명했듯이, 팀원들이 코드를 작성을 하면 1. 코드의 문법상 이상이 있는지 확인하고, 2. 반드시 동작해야 하는 기능이 동작하는지 확인하고, 이상이 없다면 PR을 Open한 상태로 유지한다. 여기에 더 관리가 잘되는 레포지토리의 경우, 3. SAST 도구를 도입해서 해당 코드의 취약점이 존재하는지까지 판단한다.

미리 CD에 대해서 설명한다면, 위의 CI 과정에서 문제가 발생하지 않는다면 자동으로 테라폼이나 도커와 같은 도구를 actions로 사용해서 현재 운영중인 서버에 배포할 수 있다. 이 과정이 우리가 프로젝트나 실제 서비스에서 사용하는 CI/CD 전부다.

2. Github Actions를 선택해야하는 이유

일반적으로 CI/CD 파이프라인을 구축할 때 사용하는 도구가 대략 두개가 있는데 젠킨스와 Github Actions다. 지금도 젠킨스를 사용하고 있는 기업도 있지만, 젠킨스는 보다 자유롭다는 장점을 가지고 있지만 만약 실제 서비스로 운용한다면 별도의 EC2로 젠킨스를 띄워야한다는 점과 Github Actions보다는 간편하지 않다는 조건으로 요즘 트렌드는 Github Actions를 쓰는 추세라고 보면 된다.

3. Github Actions를 사용하는 방법

Github Actions를 사용하는 방법은 작업을 진행할 레포지토리 내에서 .github/workflows/ 안에 .yml 또는 .yaml의 확장자를 가지는 파일을 작성하면 된다. 해당 디렉토리 외에 파일을 작성한다면 동작하지 않기 때문에 반드시 참고하길 바란다.

1. name

.github/workflows 안에 존재하는 .yml과 .yaml로 끝나는 파일 하나를 워크플로우라고 부른다. name은 이 워크플로우의 이름을 지정할 수 있다. 대부분 CI workflow와 같은 방식으로 해당 워크플로우의 목적을 적는다.

2. on

on은 어떤 행동에 해당 워크플로우가 trigger가 되는지를 정의한다. 자주 사용되는 on은 크게 두가지가 있는데 pull_request, push가 있다. 만약 on을 push로 설정한다면, 해당 레포지토리에 push가 들어온다면 동작하게 되고, pull_requst라면 해당 레포지토리에 pr이 들어올 때 동작하게 된다.

3. jobs

Github Actions의 워크플로우는 기본적으로 Job 단위로 동작하는데 여러개의 jobs로 구성된다. 각각의 job은 독립적인 환경으로 동작되며 각각의 job에 여러 step을 정의하여 실행시킬 수 있다.

4. steps

각 job에 실행시킬 동작을 여러개의 step으로 나눌 수 있고, 각각의 step은 uses, run, env, id 등으로 구성된다. uses에는 Github actions를 지정할 수 있으며, 각각의 run은 일반적인 linux에서 쓰는 명령어를 사용할 수 있다. env는 변수에서 알 수 있듯이, 환경변수를 불러올 수 있는 기능이고 id는 B라고 하는 태스크가 A라고 하는 태스크에 의존한다면 id를 작성해서 needs에 연결시키는 방식으로 사용할 수 있다.

1. 함수 생성

일단 전달받은 정수 값에서 2를 더해서 return하는 함수를 정의한다.

1
def func(x: int) -> int:
2
    return x + 2

2. 테스트 함수 생성

파이썬 환경에서 테스트를 진행할 때, pytest 라이브러리를 사용할 예정이다.

1
from main import func
2

3
def test_func():
4
    assert func(3)==5

위와 같은 코드를 실행시켜보면, 아래와 같은 결과가 나온다.

1
> uv run pytest src/test_main.py

반면, 만약 테스트가 잘못된다면 어떤 결과를 반환하는지 확인해본다.

1
from main import func
2

3
def test_func():
4
    assert func(3)==4

만약, 이 과정을 CI 워크플로우에 도입한다면, 프로젝트 내에서 중요한 기능을 테스트로 미리 구현해두고 해당 테스트가 실패한다면 PR을 막는 로직을 구현할 수 있을 것이다.

3. CI 워크플로우 생성

그렇다면, 이제 이 로직을 어떻게 Github Actions에서 동작하게 할것인가?

1
name: This is CI test # 이름을 지정
2
on: push # push가 되었을 때 이 워크플로우를 동작
3
jobs:
4
  build: # Job 이름 지정
5
    runs-on: ubuntu-latest # ubuntu 사용
6
    steps:
7
    - name: Install the latest version of checkout
8
      uses: actions/checkout@v7 # 뒤에서 설명하겠지만, checkout 사용
9
    - name: Install the latest version of uv
10
      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # uv 설치
11
    - name: Install uv package
12
      run: uv sync # 의존성 설치
13
    - name: Test defined function
14
      run: uv run src/test_main.py # 테스트 진행

이 로직을 직접 볼 수 있다. 성공할 경우에는 초록색 체크 표시가 뜨지만, 실패한다면 빨간색 X 표시가 뜰 것이다.