[CICD] Github Actions의 event

 

Github Actions의 event

 

1. push

• 레파지토리 / .github / workflows / push.yaml 파일 작성하기
• push.yaml
  • name : 액션 창에서 표현 될 시각화 이름
  • on : 워크플로우 트리거 할 이벤트. 트리거 타입
  • jobs : 실행시킬 job의 집합. 필수
  • custom-job-name : job이름은 자유
  • runs on : job을 실행시킬 runner 지정하기
  • steps : step의 집합
  • - name : job이 실행시킬 스탭 정의하기. 스탭마다 이름을 명시적으로 작성/생략 가능
  • run : step에서 실행할 내용. |를 이용하면 멀티라인 커맨드 작성 가능

name: push-workflow
on: push

jobs:
  push-job:
    runs-on: ubuntu-latest
    steps:
    - name: step1
      run: echo hello hello hello world 1
    - name: step2
      run: |
        echo hello world 2
        echo github action first-day

Actions

 

 

2. pull request

• 변경사항을 코드 저장소에 합병시킬 때 하용하는 pull request
• on : pull_request
• types : 액티비티 타입으로 좀 더 세밀하게 설정 가능

name: pull-request-workflow
on: 
  pull_request:
    types: [opened]


jobs:
  pull-request-job:
    runs-on: ubuntu-latest
    steps:
    - name: step1
      run: echo hello pull-request world
    - name: step2
      run: |
        echo hello world
        echo github action pull-request

세부적인 activity 타입을 지정하지 않으면 default activity type인 opened, synchronize, reopened 이벤트가 발생할 때마다 GitHub Action이 트리거 됨

풀 리퀘스트가 open될 때만 깃허브 액션 트리거를 원하면 명시적으로 액티비티 타입을 지정해주기

이벤트를 세밀하게 지정하기 위해서는 on - 이벤트에 types 키워드와 타입을 명시해줘야함

 

 

 

 

3. issue

• 버그, 기능 요청, 질문, 논의 등 추적 및 관리
• 프로젝트의 버그나 기능 개발 등의 진행 상황 파악 가능함
• 깃허브 상단의 Issues 탭에서 생성 가능함
  • 이슈탭이 보이지 않는다면 셋팅에서 Features - Issues  활성화 해주기
• 모든 액티비티 타입에 의해 트리거가  됨
• 이슈가 오픈 될 때만 트리거 되는 yaml 예시

name: issue-workflow
on:
  issues:
    types: [opened]

jobs:
  issue-job:
    runs-on: ubuntu-latest
    steps:
    - name: step1
      run: echo hello issue-world
    - name: step2
      run: |
        echo hello world
        echo github action of issue-workflow

issue 만들기

opened 액션에 의한 이벤트 트리거

• 이슈 이벤트는 오직 디폴트 브랜치에서만 트리거됨
  • 그 파일이 디폴트 브랜치에 존재해야 한다는 것

 

 

 

 

4. issue comment

• issue 이벤트에 코멘트를 다는 것
• pull request 이벤트에 코멘트를 다는 것
• 이슈 이벤트처럼 디폴트 브랜치에서만 동작
• 모든 액티비티 타입에 대해서 트리거 됨
• if : 깃 허브 컨텍스트 사용 (나중에 보충설명), job이 실행되기 전에 조건을 걸 수 있음
• 예시 yaml
  • job_1 : pull request에 코멘트를 달 때 실행됨 / job_2 : issue에 코멘트를 달 때 실행됨

name: issue-comment-workflow
on: issue_comment

jobs:
  pr-comment:
    if: ${{ github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
    - name: pr comment
      run: echo ${{ github.event.issue.pull_request }}


  issue-comment:
    if: ${{ !github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
    - name: issue comment
      run: echo ${{ github.event.issue.pull_request }}

조건부 실행

조건부 실행

 

 

 

 

 

5. schedule

• 특정 시간에 Github Workflow를 실행하는 
• cron 키워드를 사용함. 트리그 될 시간을 지정할 수 있음

cron

• 스케줄 이벤트는 디폴트 브랜치에 GitHub Action Workflow가 있어야만 동작함
• 그러나 지정한 시간에 정확히 동작하지 않을 때가 있음
  • Github Actions 사용에 대한 높은 부하가 있는 경우 딜레이 되기도 하거나, 아예 실행되지 않기도 함
  • 5분 간격, 30분 간격의 작업은 드랍될 가능성 있음
  • 정해진 시간에 꼭 실행되어야 하는 작업인 경우 깃헙액션 스케줄링 사용 X

 

 

 

6. workflow_dispatch

• 사용자가 원할 때 수동으로 트리거할 수 있
• 디폴트 브랜치에서만 동작함
• 인풋값을 넣으면 깃헙액션에서 받아올 수 있음
• 인풋값을 정의하려면 이벤트에서 inputs 키워드 사용하기
• 인풋 데이터 타입
  • String, number, boolean, choice

인풋 데이터 타입

name: workflow_dispatch
on: 
  workflow_dispatch:
    inputs:
      name:
        description: 'set name'
        required: true
        default: 'github-actions'
        type: string
      environment:
        description: 'set env'
        required: true
        default: 'dev'
        type: choice
        options:
          - dev
          - qa
          - prod  

jobs: 
  workflow-dispatch-job:
    runs-on: ubuntu-latest
    steps:
    - name: step1
      run: echo hello world
    - name: step2
      run: |
        echo hello world
        echo github action
    - name: echo input
      run: |
        echo ${{ inputs.name }}
        echo ${{ inputs.environment }}

Run workflow

값 확

 

 

다양한 이벤트로 하나의 워크플로우 트리거 하기

name: multiple-event-workflow
on:
  push: {} # push 이벤트에 대한 세부 설정을 명시적으로 비워두기
  issues: 
    types: [opened] # issues 이벤트에 대해 "opened" 타입만 반응하도록 설정
  workflow_dispatch: # 수동 트리거를 위해 workflow_dispatch 이벤트 추가

jobs:
  multiple-event-job:
    runs-on: ubuntu-latest
    steps:
    - name: step1
      run: echo hello world
    - name: step2
      run: |
        echo hello world 
        echo github action

• multipleEvent.yaml 파일 push로 인해 바로 액션 발생함

액션 발생

 

 

 

 

needs

• 하나의 워크플로우 안에서 여러 개의 job을 정의해서 사용하는 경우
• 여러 개의 job을 정의 시 기본적으로 병렬 실행
• job 사이의 종속성이 필요한 경우 needs 키워드를 사용
• job1 -> job2 / job3 -> job4 종속성을 가진 needs.yaml 예시 작성
• exit 1 : 강제 실패 시키기

name: needs
on: push

jobs:
  job1:
    runs-on: ubuntu-latest
    steps:
    - name: echo
      run: echo "job1 done"

  job2:
    runs-on: ubuntu-latest
    needs: [job1]
    steps:
    - name: echo
      run: echo "job2 done"

  job3:
    runs-on: ubuntu-latest
    steps:
    - name: echo
      run: |
        echo "job3 failed"
        exit 1  
        
  job4:
    runs-on: ubuntu-latest
    needs: [job3]
    steps:
    - name: echo
      run: echo "job4 done"

needs 예제 결과

• 깃허브 액션에서는 종속성 있는 job이 실패하더라도 실행할 수 있도록 하는 방법을 제공함 (if condition)

 

 

 

re-run

• 과거에 실행된 워크플로우를 재실행함
• 성공, 실패 여부와 상관 없이 재실행 가능함
• 트리거된 그 시점을 다시 실행
• 과거에 실행된 워크플로우를 re-run해도 수정한 내용(워크플로우 실행 후 수정된 내용)은 반영되지 않음