Github actions: Basic (with YAML)

---

🧐 Github actions?

Github actions는 Github에서 제공하는 workflow를 자동화할 수 있는 도구이다. 즉, Github에서 직접 제공하는 CI/CD 도구라고 할 수 있다.
CI로 쓴다는 의미는 테스트 실행이나 빌드 검사, 컨벤션 검사를 통해 코드가 의도대로 동작하고 잘 작성되었는지를 확인할 수 있다는 의미이고 CD는 서버에 배포하거나 레지스트리에 발행하는 등의 행위를 할 수 있다는 의미이다.
이러한 CI/CD 도구에는 Travis CI, CircleCI 등이 있지만 Github actions는 작성이 쉬우면서도 확장성이 좋고, Github 마켓 플레이스에서 여러 사람이 공유한 Workflow를 찾을 수 있으며, 자신이 직접 만들어서 공유할 수도 있다는 장점이 있다.

---

📚 YAML (YAML Ain't Markup Language)

Github actions의 workflow들은 yaml(야믈)문법으로 작성되어 /.github/workflows에 xxx.yml형태로 저장된다.
따라서 YAML에 대해 익숙할수록 워크플로우를 작성하기 수월해지기때문에 YAML에 대해 간단하게 정리하고 넘어가보려 한다.

YAML 이란? (vs JSON)

YAML의 의미는 "또 다른 마크업 언어 (Yet Another Markup Language)"였으나, 문서 마크업 형식이 아니고 데이터 중심에 있다는 것을 보여주기 위하여 "YAML은 마크업 언어가 아니다 (YAML Ain't Markup Language)"라는 이름을 채택하였다고 한다.

YAML은 JSON과 마찬가지로 사람이 읽기 쉽게 가독성을 고려하여 설게된 데이터 교환포맷이다. JSON은 단순화와 범용성에 중점을 둔 반면, YAML은 가독성에 중점을 두었다는 점에서 차이가 발생한다. 따라서 JSON에 비하여 YAML파일은 생성과 해석이 비교적 복잡한 편이다.

YAML 문법

이번 글에서는 YAML의 모든 문법을 알아본다기 보다는 workflow 작성에 필요한 문법들만 간략히 정리해보려한다.

데이터 정의 (map)

데이터는 들여쓰기 및 key: value 형태로 정의한다.

// YAML
apiVersion: v1
kind: Pod
metadata:
  name: echo
  labels:
    type: app

// JSON
{
  "apiVersion": "v1",
  "kind": "Pod",
  "metadata": {
    "name": "echo",
    "labels": {
      "type": "app"
    }
  }
}

이때 key와 value사이에는 반드시 빈칸이 존재해야한다.

# error (not key-value, string)
key:value

# ok
key: value

배열 정의 (array)

배열은 하이픈(-) 형태로 정의한다.

// YAML
person:
  name: Chungsub Kim
  job: Developer
  skills: 
    - docker
    - kubernetes

// JSON
{
  "person": {
    "name": "Chungsub Kim",
    "job": "Developer",
    "skills": [
      "docker", "kubernetes"
    ]
  }
}

주석

주석은 #으로 표시한다.

# 주석주석주석

줄바꿈

|지시어는 마지막 줄바꿈 포함, |-지시어는 마지막 줄바꿈 제외, >지시어는 중간에 들어간 빈줄을 제외한다.

// YAML
newlines_sample: |
            number one line

            second line

            last line

// JSON
{
  "newlines_sample": "number one line\n\nsecond line\n\nlast line\n"
}

YAML 변환 사이트

json2yaml
위 사이트에서 JSON을 YAML 변환할 수 있다.

---

🏃🏻‍♂️ workflow 구성 살펴보기

repository의 Actions 탭에서 workflow를 작성할 수 있다.

직접 처음부터 작성할 수도 있지만, 처음에는 아래의 추천 템플릿에서 수정하면서 작성하는 것을 추천한다.

name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node: [ 12,14,16 ]

    steps:
      - name: checkout to repository
        uses: actions/checkout@v2

      - name: Run a one-line script
        run: echo Hello, world!
      - run: npm test

위의 기본 템플릿을 예시로 워크플로우의 구성을 간단히 정리해보도록 하겠다.😎

name

name: CI

name은 이 워크플로우의 이름이다. GitHub Actions에서는 다수의 워크플로우를 설정할 수 있는데 파일마다 하나씩 설정할 수 있다.
이렇게 작성한 이름은 repository의 Actions탭에서 아래처럼 확인할 수 있다. (name: PR Test)

on

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

on은 필수값으로 워크플로우에 이벤트를 설정할 수 있다. 위에서는 push와 pull_reqeust의 main 브랜치에 대해서 설정한 것인데 간단하게

on: [push, pull_request]

로 설정하는 것도 가능하다.
다양한 이벤트가 있으며 이는 이곳에서 확인할 수 있다.
repository_dispatch를 설정하면 Github 외부에서 발생하는 활동으로도 이벤트를 발생시킬 수 있으며,
schedule 이벤트를 설정하면 POSIX cron 문법으로 아래처럼 특정 시간에 이벤트를 발생시킬 수 있다.

on:
  schedule:
    # KST 기준, 월-금 06시
    - cron: "0 21 * * 0-4"

jobs

jobs:
  build:

jobs는 워크플로우의 기본 단위라고 보면 되며 다시 더 작은 단위인 스텝(step)으로 이루어져 있다.
위에서는 jobs.build로 되어 있는데 실제 문법은 jobs.<job_id>가 된다. build는 임의로 지정한 이름이고 아무 이름이나 지정할 수 있다. 여기서는 build라는 잡 하나만 있지만 이름처럼 여러 개의 잡을 설정할 수 있다.

jobs는 기본적으로 병렬적으로 실행되지만 needs키워드를 통해 의존성을 갖도록 설정할 수도 있다.
아래는 needs키워드를 추가하여 test작업이 build작업 이후에 실행되도록 설정한 것이다.

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - run: ./build_server.sh
  test:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - run: ./test_server.sh

runs-on

    runs-on: ubuntu-latest

runs-on은 잡을 실행할 운영체제로 Windows, Linux, macOS를 지정할 수 있고 노드를 직접 운영하는 경우에는 self-hosted를 지정할 수도 있다.

strategy

    strategy:
      matrix:
        node: [ 12,14,16 ]

strategy는 위 설정처럼 같은 잡을 여러 버전의 환경에서 실행하고 싶을 때 행렬을 구성한다. 위에서는 Node.js 12, 14, 16버전에서만 실행했지만 os까지 지정하면 더 복잡한 행렬을 구성할 수도 있다.

steps

    steps:
      - name: checkout to repository
          uses: actions/checkout@v2

      - name: Run a one-line script
        run: echo Hello, world!
      - run: npm test

steps는 잡의 실제 동작을 정의하는 부분이며 yaml문법상 하이픈(-)으로 분류되어 하나의 step이 구성된다.
name은 필수값이 아니지만, 하나의 step은 하나의 uses 또는 run 키워드가 존재해야 한다.
run 키워드는 시스템의 shell에 실행될 명령어를 직접 작성해주어야 하지만,
uses키워드는 이미 다른 회사나 사람들이 만들어서 올려둔 액션을 설정을 통해 사용할 수 있다. 이렇게 만들어진 액션들은 마켓플레이스에서 쉽게 공유할 수 있다.

---

내용이 길어진 관계로 다음 글에서 직접 워크플로우를 작성해보겠다!😎

🙏 참고

• GitHub Actions 워크플로우 사용하기
• Github Actions으로 배포 자동화하기
• 쿠버네티스 안내서