[GitHub Actions] GitHub Actions이란? 구성요소 및 Workflows 파일 예제 살펴보기

Intro

안녕하세요. 요새 회사에서 git actions을 통해 CI/CD 를 구축하고 있습니다. git actions 이 무엇이고, 구성요소 및 workflows 워크플로 파일 예제에 대해 정리해 놓으면 좋을 것 같아 이번 시간에는 Github Actions 에 대해 알아보려고 해요.

What is a Git Actions?

GitHub Actions는 build, test, deployment pipeline 을 자동화할 수 있는 CI/CD(연속 통합 및 지속적인 업데이트) 플랫폼입니다. repository에 대한 모든 pull request 을 build 및 test하거나 merged pull requests 을 프로덕션에 배포하는 워크플로를 만들 수 있습니다.

GitHub Actions의 구성 요소

pull request 이 열리거나 이슈가 생성되는 것과 같은 ‘event’가 repository에서 발생할 때 트리거되도록 GitHub Actions ‘워크플로’를 구성할 수 있습니다. 워크플로는 순차적 또는 병렬로 실행될 수 있는 ‘작업’을 하나 이상 포함합니다.

Workflows

워크플로(workflows) 는 하나 이상의 작업을 실행하는 구성 가능한 자동화된 프로세스입니다. 워크플로는 repository에 체크 인된 YAML 파일에서 정의되며, repository의 이벤트로 트리거될 때 실행되거나 수동으로 또는 정의된 일정에 따라 트리거될 수 있습니다. repository의 .github/workflows 디렉터리에 정의되며 repository에는 여러 워크플로가 있을 수 있으며, 각 워크플로는 다른 작업 세트를 수행할 수 있습니다. 예를 들어 pull request을 빌드 및 테스트하는 워크플로, 릴리스가 생성될 때마다 애플리케이션을 배포하는 워크플로 등이 있을 수 있습니다.

Events

이벤트는 워크플로 실행을 트리거하는 repository의 특정 활동입니다. 예를 들어 repository에 커밋을 푸시할 때 GitHub에서 활동이 시작될 수 있습니다. 일정에 따라 수동으로 워크플로 실행을 트리거할 수도 있습니다.

Jobs

Jobs 은 동일한 실행기에서 실행되는 워크플로의 ‘단계’ 집합입니다. 각 단계는 실행되는 셸 스크립트 또는 실행되는 ‘Jobs’입니
\‘Actions’은 복잡하지만 자주 반복되는 태스크를 수행하는 GitHub Actions 플랫폼용 사용자 지정 애플리케이션입니다.

Action

Actions 을 사용하여 워크플로 파일에 작성하는 반복 코드의 양을 줄일 수 있습니다. 작업은 GitHub에서 git 리포지토리를 풀하거나, 빌드 환경에 맞는 도구 체인을 설정하거나, cloud provider 에 대한 인증을 설정할 수 있습니다.

Runners

runner는 트리거될 때 워크플로를 실행하는 서버입니다. 각 실행기는 한 번에 하나의 작업을 실행할 수 있습니다. GitHub은(는) 워크플로를 실행할 Ubuntu Linux, Microsoft Windows, macOS 실행기를 제공합니다.

Create an example workflow

1. repository 에서 워커플로 파일을 저장할 .github/workflows/ 디렉토리를 만들어야 합니다.
2. .github/workflows/ 디렉터리에서 github-actions.yml 이라는 새 파일을 만들고 다음 코드를 추가합니다.

name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '14'
      - run: npm install -g bats
      - run: bats -v

3. 변경 내용을 커밋하고 GitHub 리포지토리에 푸시합니다.

참고로, 위 파일은 예제일 뿐입니다. 예시로 SpringBoot + java 11 version 개발환경에서 workflow 파일 작성시 해당 자바 버전을 명시해주면 됩니다.

Understanding the workflow file

name: learn-github-actions

Optional - github repository의 Actions 탭에 표시되는 워커플로의 이름입니다.

run-name: ${{ github.actor }} is learning GitHub Actions

Optional - 워크플로에서 생성된 워크플로 실행의 이름으로, 리포지토리의 "Actions" 탭에 있는 워크플로 실행 목록에 표시됩니다.

on: [push]

워크플로의 트리거를 지정합니다. 이 예제에서는 push 이벤트를 사용하므로 누군가가 repository에 변경 내용을 푸시하거나 pull request 을 병합할 때마다 워크플로 실행이 트리거됩니다.

jobs:

github-actions 워크플로에서 실행되는 모든 작업을 그룹화 해줍니다.

check-bats-version:

check-bats-version이라는 작업을 정의합니다.

  runs-on: ubuntu-latest

Ubuntu Linux 의 최신 버전에서 실행되도록 job 을 구성합니다. 즉, GitHub에서 호스트된 새 가상 머신에서 작업이 실행됩니다.

  steps:

check-bats-version 작업에서 실행되는 모든 단계를 그룹화합니다. 이 섹션 아래에 중첩된 각 항목은 별도의 작업 또는 shell script 입니다.

 - uses: actions/checkout@v3

uses 키워드는 이 단계에서 actions/checkout 작업의 v3를 실행하도록 지정합니다. 이 작업은 repository를 실행기로 체크 아웃하여 스크립트 또는 코드에 대한 기타 작업(예: 빌드 및 테스트 도구)을 실행할 수 있도록 합니다. 워크플로가 repository의 코드에 대해 실행될 때마다 체크 아웃 작업을 사용해야 합니다.

    - uses: actions/setup-node@v3
      with:
        node-version: '14'

이 단계에서는 actions/setup-node@v3 작업을 사용하여 지정된 버전의 Node.js를 설치합니다(이 예제에서는 v14 사용). 이렇게 하면 node 및 npm 명령이 모두 PATH에 배치됩니다.

    - run: npm install -g bats

run 키워드는 실행기에서 명령을 실행하도록 작업에 지시합니다. 이 예제에서는 npm을 사용하여 bats 소프트웨어 테스트 패키지를 설치합니다.

    - run: bats -v

최종적으로, 소프트웨어 버전을 출력하는 매개 변수와 함께 bats 명령을 실행합니다.

Conclusion

이상 GitHub Actions이 무엇이고, 구성요소 및 Workflows 파일 예제 살펴봤습니다. 처음에 보면 낯설어서 어려워보일 수 있는데요, 하나 하나 뜻을 확인하면 그리 어렵지 않은 개념인 것 같습니다 :)

---

https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions