[Github] Github Actions란?

---

🎯 

Github Actions를 이해할 수 있다.

---

✅ Github Actions

소프트웨어 workflow를 자동화 할 수 있도록 도와주는 도구

 

ex)
1. 내가 github에 코드를 올리면 특정 수행을 하도록 하고 싶다.

2. 해당 코드가 주기적으로 동작했으면 좋겠다. (날씨, 뉴스 크롤링 등)

 

GitHub Actions를 사용하면 자동으로 코드 저장소에서 어떤 이벤트(event)가 발생했을 때 특정 작업이 일어나게 하거나 주기적으로 어떤 작업들을 반복 실행 가능하다.

 

이렇게 소프트웨어 프로젝트에서 지속적으로 수행해야하는 반복 작업들을 업계에서는 소위 CI/CD라고 많이 줄여서 부르는데 사람이 매번 직접 하기에는 비효율적인데다가 실수할 위험도 있기 때문에 GitHub Actions과 같은 것들로 자동화시키는 것이 유리하다.

 

GitHub Actions는 기존 CI/CD 서비스 대비 간편한 설정과 높은 접근성으로 특히 개발자들 사이에서 많은 호응을 얻고 있는데 예전에는 CI/CD가 DevOps 엔지니어의 전유물로만 여겨지곤 했었는데 최근에는 GitHub Actions을 통해서 일반 개발자들도 어렵지 않게 CI/CD 설정을 스스로 하기 쉬워졌다.

이렇듯 전세계에 대부분의 개발자들이 이미 GitHub 계정이 있다고 해도 과언이 아닌 유리한 상황에서, GitHub가 Microsoft에 인수된 이후 야심차게 출시한 GitHub Actions은 Jenkins, Circle CI, Travis CI와 같은 기존에 유수의 서비스까지도 위협하는 중이다.

✅ Github Actions Example

• 코드 저장소에 Pull Request를 생성하게 되면 GitHub Actions를 통해 해당 코드 변경분에 문제가 없는지 각종 검사를 진행
• 어떤 새로운 코드가 메인(main) 브랜치에 유입(push)되면 GitHub Actions를 통해 소프트웨어를 빌드(build)하고 상용 서버에 배포(deploy) 가능
• 특정 시각에 특정 데이터 크롤링 가능

✅ Workflows

 

GitHub Actions에서 가장 상위 개념인 워크플로우(Workflow, 작업 흐름)는 자동화해놓은 일련의 작업 과정이다.

이때 워크플로우는 코드 저장소 내에서 .github/workflows 폴더 아래에 위치한 YAML 파일 로 설정하며, 하나의 코드 저장소에는 여러 개의 워크플로우, 즉 여러 개의 YAML 파일을 생성 가능하다.

 

Workflow의 대표적인 예

• Test Codevalue에 특정 값이 들어가는가?
• 특정 함수의 return 값이 어떻게 나오는지 확인하는 TC
• Deploy
• 서버에 새로운 기능, 버전 등을 배포
• Automation
• 자동화하고자 하는 스크립트 생성
• 다양한 버전에서 실행되는지 확인
• Ubuntu의 최신버전에서 동작하는지, Python 3.5~3.8 버전에서 동작하는지

 

---

main 브랜치에 push 이벤트가 발생할 때 마다 워크플로우 실행하는 방법

 

.github/workflows/example.yml

on:
  push:
    branches:
      - main

jobs:
  # ...(생략)...

 

매일 자정에 워크플로우 실행하는 방법

 

.github/workflows/example.yml

on:
  schedule:
  - cron: "0 0 * * *"

jobs:
  # ...(생략)...

---

✅ Jobs

워크플로우가 구체적으로 어떤 일을 해야하는지 명시하는 곳이다.

 

독립된 가상 머신(machine) 또는 컨테이너(container)에서 돌아가는 하나의 처리 단위를 의미한다.

하나의 워크플로우 는 여러 개의 작업 으로 구성되며 적어도 하나의 작업은 필요하다.

모든 작업은 기본적으로 동시에 실행되며, 필요 시 작업 간에 의존 관계를 설정하여 작업이 실행되는 순서를 제어할 수 있다.

 

---

작업은 워크플로우 YAML 파일 내에서 jobs 속성을 사용하며 작업 식별자(ID)와 작업 세부 내용 간의 맵핑(mapping) 형태로 명시

예를 들어 job1, job2, job3이라는 작업 ID를 가진 3개의 작업을 추가하려면 다음과 같이 설정

 

.github/workflows/example.yml

# ...(생략)...

jobs:
  job1:
    # job1에 대한 세부 내용
  job2:
    # job2에 대한 세부 내용
  job3:
    # job3에 대한 세부 내용

작업의 세부 내용으로는 여러 가지 내용을 명시할 수 있는데

필수로 들어거야 하는 runs-on 속성을 통해 해당 리눅스나 윈도우즈와 같은 실행 환경을 지정

예를 들어, 가장 널리 사용되는 우분투의 최신 실행 환경에서 해당 작업을 실행하고 싶다면 다음과 같이 설정

 

.github/workflows/example.yml

# ...(생략)...

jobs:
  job1:
    runs-on: ubuntu-latest
    steps:
      # ...(생략)...

---

✅  Steps

작업 순서를 정의하는 곳이다.

 

각 작업(job)은 하나 이상의 단계(step)로 모델링한다.

작업 단계는 단순한 커맨드(command) 혹은 스크립트(script*거나 액션(action)같은 복잡한 명령이다.

커맨드나 스크립트를 실행할 때는 run 속성을 사용하며, 액션을 사용할 때는 uses 속성을 사용한다.

 

---

예를 들어 자바스크립트 프로젝트에서 테스트를 돌리려면

코드 저장소에 코드를 작업 실행 환경으로 내려 받고 → 패키지를 설치 → 테스트 스크립트를 실행한다.

이러한 3단계 작업은 아래와 같이 steps 속성을 통해서 명시 가능하다.

 

.github/workflows/example.yml

# ...(생략)...

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install
      - run: npm test

💡 워크플로우 파일 내에서 작업 단계를 명시해줄 때는 반드시 - 를 붙여야 함

(YAML 문법에서 시퀀스(sequence) 타입을 사용하기 때문)

---

✅  Actions

반복 단계를 재사용하기 용이하도록 제공되는 일종의 작업 공유 메커니즘이다.

 

하나의 코드 저장소 범위 내에서 여러 워크플로우 간에서 공유를 할 수 있을 뿐만 아니라, 공개 코드 저장소를 통해 액션을 공유하면 GitHub 상의 모든 코드 저장소에서 사용이 가능하다.

GitHub에서 제공하는 대표적인 공개 액션 : 체크 아웃 액션(actions/checkout)

대부분의 CI/CD 작업은 코드 저장소로 부터 코드를 작업 실행 환경으로 내려받는 것으로 시작 → 체크 아웃 액션은 엄청나게 범용적으로 사용한다.

뿐만아니라 GitHub Marketplace에서는 수많은 벤더(vendor)가 공개해놓은 다양한 액션이 존재한다.

즉, 이러한 액션을 중심으로 하나의 큰 커뮤니티가 형성이 되고 더 많은 사용자와 벤더가 GitHub Actions으로 몰려드는 선순환이 발생한다.

 

 

[출처]

https://www.invicti.com/support/integrating-invicti-enterprise-github-actions/

https://zzsza.github.io/development/2020/06/06/github-action/

https://www.daleseo.com/github-actions-basics/