Github Actions란 뭘까

목차

1. Github Actions란?

2. 작성 예시

3. 구성 요소 자세히 보기

    3-1. Workflow

    3-2. Event

    3-3. Job

    3-4. Runner

    3-5. Step

    3-6. Action

---

1. Github Actions란?

Github에서 제공하는 빌드, 테스트 및 배포 파이프라인을 자동화할 수 있는 CI/CD 플랫폼

Github 저장소에 이벤트(push, pr..)가 발생하면 미리 정의한 작업(테스트-빌드-배포..)을 자동으로 실행해준다.

 

Github Actions의 구성 요소에 대해 알아보자

구성 요소	설명
Workflow	자동화 프로세스가 정의된 스크립트 파일로, Github Actions에서 가장 최상위 개념이다.
Event	Workflow를 실행시키는 트리거로, push/pull request와 같은 동작이다.
Job	독립적으로 실행되는 작업 단위로, 병렬/순차 실행이 가능하다
Step	Job 내부에서 실행되는 세부 작업으로, 스크립트 실행/액션을 사용한다.
Action	Step에서 실행하는 재사용 가능한 작업으로, npm 설치/빌드/테스트 등이 있다.
Runner	workflow를 실행시키는 서버 환경으, 각 runner는 한 번에 하나의 Job을 실행할 수 있다.

 

 

---

2. 작성 예시

name: CI

on: [push, pull_request]

jobs:
	build:
    	runs-on: ubuntu-latest
        
        steps:
        	- uses: actions/checkout@v3
            - name: Use Node.js
              uses: actions/setup-node@v3
              with:
                  node-version: 18
                  
            - name: Install dependencies
              run: npm install
             
            - name: Run test
              run: npm test

• push, pull_request 이벤트가 발생하면 실행
• 무엇을?
  • Node.js 환경에서
  • npm install, npm test를 자동 실행

 

---

3. 구성 요소 자세히 보기

1. Workflow

위와 같이 자동화를 구성하기 위한 문서이다.

워크플로우의 이름은 name 키워드로 작성한다.

 

2. Event

이벤트는 on 키워드에 의해 지정된다.

on: [push, pull_request]

 

혹은 브랜치까지 명시하여 더 정확하게 작성할 수도 있다.

on:
	push:
    	branches:
         - main
    pull_request:
    	branches:
         - develop

 

 

3. Job

위 예시에서는 간단하게 작성했지만 Job의 구성요소는 더 있다.

키	설명
name	(선택) Job의 이름. 생략하면 ID로 표시된다
runs-on	Runner 지정 키워드이다.
steps	Job 내에서 실행할 작업들을 순서대로 정의한 배열로, 각 step은 run이나 uses로 정의된다.
needs	(선택) 다른 Job이 선행되어야 이 Job이 실행되도록 선정한다. (의존성 지정) 의존성이 없는 Job들은 모두 병렬로 시작되어 처리된다.
envs	(선택) Job 내에서 사용할 환경 변수를 설정한다.
defaults	(선택) Step 내 기본 설정값을 지정한다. (ex. shell, working-directory 등)
if	(선택) Job의실행 조건으로, 특정 조건에 Job이 실행되도록 제어한다.
timeout-minutes	(선택) Job이 실행될 최대 시간으로, 초과 시 자동 취소 된다
continue-on-error	(선택) Job이 실패해도 워크플로우를 계속 실행할 지 지정한다. (true / false)

jobs:
  build:
    name: Build Job
    runs-on: ubuntu-latest
    needs: test
    env:
      NODE_ENT: production
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        
           ...

 

 

4. Runner

Runner는 runs-on 키워드에 의해 지정된다.

runner는 Github Actions 워크플로우를 실제로 실행하는 머신(가상머신or 컨테이너)으로,

두 가지 유형이 있다.

 

Github host runner (공식 제공 러너)의 대표적인 값들 : 

운영체제	runs-on 값
Ubuntu Linux	ubuntu-latest ubuntu-22.04 ubuntu-20.04 ubuntu-18.04
Windows	windows-latest windows-2022 windows-2019
macOS	macos-latest macos-13 macos-12 macos-11

이렇게 버전을 명시하여 실행한다.

 

self hosted runner

사용자가 직접 관리하는 러너는 다음과 같이 지정한다.

runs-on: [self-hosted, linux, x64]

셀프 호스티드 러너임을 명시하며, OS, 아키텍처 등 태그를 조합하여 선택할 수 있다.

 

5. Step

step의 주요 구성 요소는 이런 것들이 있다.

키	설명	용도	예시
name	step의 이름 지정	로그/실행 결과에서 식별이 용이하도록 도움	name: Checkout repository
uses	외부/커스텀 액션 호출	미리 만들어진 재사용 액션을 실행	uses: actions/checkout@v3
run	셸명령어/스크립트 실행	복잡한 작업을 직접 커맨드로 수행	- run: echo "Hello, world!"
with	uses로 호출한 액션에 입력값 전달	액션의 설정값/옵션 지정	uses: actions/setup-node@v3 with:   node-version: '16'
env	해당 step에서 사용할 환경변수 설정	step 내 셸명령이나 액션에서 참조할 변수 지정	run: echo $MY_VAR env:   MY_VAR: "value"
if	조건에 따라 실행 여부 결정	특정 조건에서만 step 실행하도록 제어	- run: echo "this runs only on main branch"   if: github.ref == 'refs/heads/main'

 

 

6. Action

uses 키워드를 통해 미리 만들어둔 액션을 호출하여 사용할 수 있다.

별도의 저장소에서 관리되며, 워크플로우 내에서 재사용 가능하다.

 

 

 

 

 

참고

Github Actions 이해

GitHub Actions 이해 - GitHub Docs