[CICD] Github Actions의 다양한 기능

 

2. Github Actions의 다양한 기능

 

1. checkout

• github repository를 가져와서 작업을 수행할 수 있도록 하는 액션
• 마켓플레이스 공식 액션
• 필요한 테스트나 빌드 작업 등을 수행할 수 있음
• 레포지토리 내용을 CICD 워크플로우에서 사용할 수 있음
• uses 키워드로 액션을 불러올 수 있음

name: checkout
on: workflow_dispatch

jobs:
  no-checkout:
    runs-on: ubuntu-latest
    steps:
    - name: check file list
      run: cat README.md

  checkout:
    runs-on: ubuntu-latest
    steps:
    - name: use checkout action
      uses: actions/checkout@v4
    - name: check file list
      run: cat README.md

checkout

no-checkout

checkout

• 첫번째 job이 실패한 이유는 checkout 미사용으로 깃허브 레파지토리를 가져오지 않았기 때문임

 

 

 

 

2. context

• 워크플로우를 실행하는 환경에 대한 정보
• 다양한 컨텍스트가 존재함

다양한 컨텍스트

• context의 사용 이유
  • 더 유연한 워크플로우를 만들기 위해서
• 각각의 컨텍스트는 JavaSctript 객체이기 때문에 출력을 하려면 문자열로 반환해줘야함
  • toJSON이라는 메서드를 사용해서 Object객체를 Json문자열로 반환할 수 있음
• context.yaml 예시

name: context
on: workflow_dispatch

jobs:
  context:
    runs-on: ubuntu-latest
    steps:
    - name: github context
      run: echo '${{ toJSON(github)}}'

• 컨텍스트 안에 어떤 레파지토리인지, 어떤 run_id 인지 등 다양한 정보을 알 수 있음

정보

• context정보를 출력해보기

    - name: check github context
      run: |
        echo ${{ github.repository }}
        echo ${{ github.event_name }}

정보 출력 성

 

 

 

 

Filter

• 이벤트가 특정 조건에 부합할 때만 워크플로우가 트리거 되도록 함
  • 워크플로우 실행을 더 효과적으로 제어할 수 있음

 

 

3. branch filter

• 특정 브랜치 이벤트에만 트리거 되는 액션

name: branch-filter
on: 
  push:
    branches: ["dev"]

jobs:
  branch-filter:
    runs-on: ubuntu-latest
    steps:
    - name: echo
      run: echo hello

 

 

 

4. path filter

• 특정 경로의 파일이 변경될 때 워크플로우를 실행하고 싶을 때 사용함
• ! 는 특정 파일, 디렉토리를 제외할 수 있

name: path-filter
on:
  push:
    path:
    - '.github/workflows/part1/*'
    - '!.github/workflows/part1/push.yaml*'

jobs:
  path-filter:
    runs-on: ubuntu-latest
    steps:
    - name: echo hello
      run: echo hello

 

 

 

 

5. tag filter

• 특정 태그에서 실행함
  • ex) v1.0.0으로 태깅해야 실행됨
• push 이벤트 에서만 사용 사능
• 태그를 사용하는 방법
  • git tag <tag-name>

태그

name: tag-filter
on:
  push:
    tags:
    - 'v[0-9]+.[0-9]+.[0-9]+' # v1.0.0    v2.0.1


jobs:
  tag-filter:
    runs-on: ubuntu-latest
    steps:
    - name: echo 
      run: echo hello

 

 

 

 

6. timeout

• 특정 시간이상 실행되면 자동으로 중단되도록 설정하는 기능
• 특정 job , 특정 step 무한루프로 인한 불필요한 자원 소모를 방지하기 위함
• default 360분
• 타임아웃 정의 레벨 : job level, step level
• timeout-minutes 라는 키워드를 사용함

name: timeout
on: push

jobs:
  timeout:
    runs-on: ubuntu-latest
    timeout-minutes: 2
    steps:
    - name: loop
      run: |
        count=0
        while true; do
          echo "seconds: $count"
          count=$((count+1))
          sleep 1
        done
      timeout-minutes: 1
    - name: echo
      run: echo hello

 

 

 

 

7. cache

• 자주 사용되는 데이터를 빠르게 불러올 수 있도록 저장하는 기능
• 의존성 설치 시간을 단축시킬 수 있음
• 깃헙 마켓플레이스의 공식 액션
• 강의 예제는 리액트 - npm start 를 위해 사용함 

name: cache
on:
  push:
    paths:
    - 'my-app/**'    # my-app 하위의 모든 파일을 포함함

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - name: checkout the code
      uses: actions/checkout@v4    # 레파지토리 체크아웃 액션
    - name: setup-node
      uses: actions/setup-node@v3    # 셋업 노드 액션 사용
      with:
        node-version: 18     # 18버전의 노드를 인스톨 하는 액션
    - name: Cache Node.js modules
      uses: actions/cache@v3
      with:    # with키워드를 사용해서 인풋같을 전달함
        path: ~/.npm    # 캐싱할 경로
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
           	 # 캐시의 키, 운영체제별로 캐시를 구분하기 위해서
        restore-keys: |
          ${{ runner.os }}-node-    # 각 운영체제별로 매시 구문 개시의 범주를 나타냄
    - name: Install dependencies     # 의존성 설치
      run: |
        cd my-app
        npm ci
    - name: npm build    # 빌드작업 실행
      run: |
        cd my-app
        npm run build

• 3번째 job은 이후에 같은 운영체제에서 동일한 package-lock.json을 가진 워크플로우가 실행될 때 이전에 저장했던 캐시를 사용해서 의존성 설치를 빠르게 수행할 수 있게 해줌

 

 

 

8. artifact

• 워크플로우 실행 중 생성된 파일/파일모음
• 동일한 워크플로우 내에서 job 사이에 데이터를 공유하는 것
• 워크플로우가 종료된 이후에도 일정기간동안 데이터를 유지함(90일)
• 다운로드도 가능함
• 깃헙 마켓플레이스에 정의된 공식 액션
  • upload-artifact
  • download-artifact

name: artifact
on: push

jobs:
  upload-artifact:
    runs-on: ubuntu-latest
    steps:
    - name: echo 
      run: echo hello-world > hello.txt   # 텍스트파일을 만들고, 문자열 집어넣기
    - name: upload artifact
      uses: actions/upload-artifact@v3    # upload-artifact 액션을 이용해서 hello.txt파일을
      with: 	                          # artifact로 업로드함
        name: artifact-test
        path: ./hello.txt

  download-artifact:
    runs-on: ubuntu-latest
    needs: [upload-artifact]
    steps:
    - name: download artifact
      uses: actions/download-artifact@v3
      with:
        name: artifact-test
        path: ./
    - name: check
      run: cat hello.txt

 

 

 

9. output

• 한 job에서 생성된 데이터를 동일한 job의 step이나, 다른 job 들과 데이터를 공유하게 해줌
• 여러 step과 job 간에 데이터를 손쉽게 전달할 수 있음
• outfut vs artifact
  • outfut : 단순한 값 전달할 때 사용함, key-value 형태로 데이터를 저장함
  • artifact : 파일 또는 파일 모음으로 데이터 공유 가능함, 파일기반 데이터 공유시 사용하기
• 사용 구조

• 설정한 아웃풋 사용하는 방법
  • 아웃풋이 정의된 스텝의 고유 id를 사용해야함

• 각 스텝은 고유한 아이디를 사용해야 아웃풋을 출력할 수 있음
• 출력 방법
  • steps.스탭_아이디.outputs.아웃풋_키
• 첫번째 스탭에서 아웃풋 설정을 하고, 두번째 스탭에서 아웃풋을 출력함

• job 형태의 아웃풀도 키 벨류 형태로 데이터를 저장함
• job 레벨에서 아웃풋 설정을 완료하면, 종속성이 있는 job은 해당 아웃풋을 사용할 수 있음

name: output
on: push

jobs:
  create-output:
    runs-on: ubuntu-latest
    outputs:
      test: ${{ steps.check-output.outputs.test }}
    steps:
    - name: echo output
      id: check-output
      run: |
        echo "test=hello" >> $GITHUB_OUTPUT
    - name: check output
      run: |
        echo ${{ steps.check-output.outputs.test }}
  
  get-output:
    needs: [create-output]
    runs-on: ubuntu-latest
    steps:
    - name: get output
      run: echo ${{ needs.create-output.outputs.test }}

 

 

 

 

10. environment variables 깃헙액션 환경변수

• step이나 job에서 사용할 수 있는 환경 변수
• key - value 형태로 데이터 저장함
• 동일한 job에서만 데이터 공유가 가능함
• 환경변수 구성방법
  • env 사용 : 워크플로우 내에서 정의함. 
    • workflow  레벨,  job 레벨, step 레벨에서 정의해서 사용할 수 있음
    • 우선순위 step >> job >> workflow
  • 미리 정의  

[ env 사용한 정의 ]

workflow &nbsp;레벨,&nbsp;&nbsp; job 레벨,&nbsp; step 레벨에서 정의

env

name: var-1
on: push

env:  
  level: workflow  # 워크플로우 레벨 env 정의

jobs:
  get-env-1:
    runs-on: ubuntu-latest
    steps:
    - name: check env
      run: echo "LEVEL ${{ env.level }}"
  
  get-env-2:
    runs-on: ubuntu-latest
    env:
      level: job   # 잡 레벨 env 정의
    steps:
    - name: check env
      run: echo "LEVEL ${{ env.level }}"

  get-env-3:
    runs-on: ubuntu-latest
    env:
      level: job
    steps:
    - name: check env
      run: echo "LEVEL ${{ env.level }}"
      env:
        level: step    # 스텝 레벨 env 정의
  
  get-env:
    runs-on: ubuntu-latest
    steps:
    - name: create env
      run: echo "level=job" >> $GITHUB_ENV  # 직접 env 정의
    - name: check env
      run: echo "LEVEL ${{ env.level }}"

 

[ 환경변수 미리 정의하기 ]

• 워크플로우 밖에서 미리 환경변수를 정의함
• 이 값을 바꾸면 워크플로우 결과가 달라질 수 있음

• Settings - security - Actions secrets and variables - Actions -  variables

name: var-2
on: push

jobs:
  get-var: 
    runs-on: ubuntu-latest
    steps:
    - name: get var
      run: echo ${{ vars.level }}

 

 

 

 

11. secrets

• 민감한 데이터를 안전하게 저장해서 워크플로우에 사용하는 것
• 민감 정보를 코드와 분리하여, 노출되는 것을 방지함
• 사용 하는 곳 : API Key, 암호, 인증 토큰
• Settings - security - Actions secrets and variables - Actions -  secrets 

name: secrets
on: push

jobs:
  get-secrets:
    runs-on: ubuntu-latest
    steps:
    - name: get secrets
      run: echo ${{ secrets.level }}

 

 

 

12. environment

• 특정 환경에서만 사용 가능한 환경변수와 시크릿을 관리하는 것
• Repository에서 정의할 수 있음
• 정의 레벨 : organization level, repository level, environment level

정의 레벨

 

 

 

 

13. matrix

• 변수를 기반으로 여러 job을 실행하는 기능
• matrix를 사용해서 하나의 잡을 구성하면, 여러 개의 잡을 실행하도록 할 수 있
• 변수로 하나의 잡으로 여러 러너(OS)가 잡을  실행하게 하거나, 같은 코드 베이스에서  각 버전별로 테스트를 구성할 수 있음

name: matrix
on: push

jobs:
  get-matrix:
    strategy:
      matrix:
        os: [windows-latest, ubuntu-latest]
        version: [12,14]
    runs-on: ${{ matrix.os }}
    steps:
    - name: check matrix
      run: |
        echo ${{ matrix.os }}
        echo ${{ matrix.version }}

 

 

 

 

14. if condition

• 특정 조건이 충족될 때만 실행되도록 할 때 사용
• 오퍼레이터를 적절히 사용해서 조건 구성하기

오퍼레이

• job 레벨, step 레벨에서 정의할 수 있dma
• filter vs if condition
  • filter : workflow 트리거를 세밀하게 제어 (ex-dev브랜치일때만 트리거)
  • if condition : workflow가 트리거 된 이후 job과 step만 세밀하게 제어 (ex-dev 브랜치일때는 첫번째 job만 실행/ master 브랜치일 때 두번째 job의 세번째 step skip하기)

name: if-1
on:
  push:
  workflow_dispatch:

jobs:
  job1:
    runs-on: ubuntu-latest
    if: github.event_name == 'push'
    steps:
    - name: get event name
      run: echo ${{ github.event_name }}
  job2:
    runs-on: ubuntu-latest
    if: github.event_name != 'push'
    steps:
    - name: get event name
      run: echo ${{ github.event_name }}
  job3:
    runs-on: ubuntu-latest
    steps:
    - name: get event name
      if: github.event_name == 'push'
      run: echo "PUSH"
    - name: get event name
      if: github.event_name != 'push'
      run: echo "WORKFLOW_DISPATCH"

 

 

 

 

15. startWith, endsWith, contains 

• 문자열 처리 함수
• 문자열 조건을 검사해서 조건이 충족되면 해당 jbob이나 step을 실행하도록 제어하는데 유용
• startWith ( searchString, searchValue )
• endsWith ( searchString, searchValue )
• contains ( search, item )
  • search는 문자열이나 배열. 배열은 콤마로 구분된 문자열 리스트로 작성

name: string-function
on: push

jobs:
  string-function:
    runs-on: ubuntu-latest
    steps:
    - name: startswith
      if: startsWith('github actions', 'git')
      run: echo "git"
    - name: startswith
      if: startsWith('github actions', 'test')
      run: echo "test"

    - name: endswith
      if: endsWith('github actions', 'ions')
      run: echo "ions"
    - name: endsWith
      if: endsWith('github actions', 'test')
      run: echo "test"

    - name: contains
      if: contains('github actions', 'act')
      run: echo "contains act"
    - name: contains
      if: contains('github, actions', 'git')
      run: echo "contains git"