Github Action #2 - 예제 분석하기

아래 예제는 Github Action에서 Workflow를 생성하면 기본으로 제공해주는 템플릿입니다. 해당 예제를 이용하여 Github Action #1 - 기본 용어 정리에서 설명한 내용을 기반으로 분석을 해보겠습니다.

# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      # Runs a single command using the runners shell
      - name: Run a one-line script
        run: echo Hello, world!

      # Runs a set of commands using the runners shell
      - name: Run a multi-line script
        run: |
          echo Add other actions to build,
          echo test, and deploy your project.

Workspace의 이름

name: CI

CI란 이름의 workspace입니다.

Event 정의하기

on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

main 브랜치에 push 또는 Pull Request 시에 해당 Workflow를 실행하도록 정의합니다. workflow_dispatch를 설정하면 특정 조건이 아니라 Github Action 탭에서 수동으로 workflow를 실행할 수 있습니다.

Job - 빌드 환경 정의하기

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

Job을 설정하는데, runs-on으로 실행될 환경을 정의합니다. 여기서는 job이 실행될 runner는 ubuntu 환경입니다.

Job - Step 정의하기

 steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      # Runs a single command using the runners shell
      - name: Run a one-line script
        run: echo Hello, world!

      # Runs a set of commands using the runners shell
      - name: Run a multi-line script
        run: |
          echo Add other actions to build,
          echo test, and deploy your project.

위에서 주의해서 보실건 uses입니다. uses는 잘 활용한다면 매우 편하게 action을 정의할 수 있습니다. uses는 이미 만들어져있는 action을 사용할 수 있습니다.
- uses: actions/checkout@v2은 github에서 이미 만들어 놓은 checkout@v2 action을 사용하는 것입니다. 해당 action은 사용자의 repository를 runner 환경에 복사하는 action이라고 생각하시면 됩니다.
그 이후로는 name과 run을 보실 수 있는데, name은 해당 step의 이름이고, run은 어떤 명령어를 수행할지 정의해줍니다.

지금까지 간단한 예제를 활용하여 분석해 보았습니다. 궁금하신 부분이나 수정이 필요한 부분은 댓글 부탁드립니다.