GitHub Actions

코드를 호스팅하고 버전 관리를 할 때 사용할 수 있는 자동화 및 CI/CD(Continuous Integration/Continuous Deployment) 도구

Workflow (워크플로우)

GitHub Actions에서 수행되는 자동화 프로세스를 정의하는 요소입니다.

•

.github/workflows 디렉토리에 YAML 형식의 워크플로우 파일을 작성하여 정의합니다.

•

워크플로우는 이벤트(예: 푸시, 풀 리퀘스트 등)가 발생할 때 시작되며, 일련의 작업 단계를 정의하여 실행됩니다.

Workflow 의 구성요소

GitHub Actions는 아래의 요소들을 조합하여 코드 빌드, 테스트, 릴리스, 배포 등의 작업을 자동으로 수행할 수 있습니다.

Workflow

•

Job (잡)

◦

Step (스텝)

▪

Actions (액션)

Job (잡)

workflow(워크플로우) 내에서 실행되는 독립적인 작업 단위

•

각 Job(잡)은 별도의 실행 컨텍스트를 가지며, 병렬 또는 순차적으로 실행될 수 있습니다.

•

각 Job(잡)은 여러 스텝으로 구성되며, 하나의 잡이 실패하면 다음 잡이 실행되지 않습니다.

Step (스텝)

Job(잡) 내에서 수행되는 개별적인 작업 단계

•

각 스텝은 독립적으로 실행되며, 앞의 스텝이 성공적으로 완료되어야 다음 스텝이 실행됩니다.

•

원하는 작업을 세분화하여 구성할 수 있습니다.

Actions (액션)

Step(스텝) 내에서 실해오디는 재사용가능한 빌드 블록

액션은 워크플로우에서 여러 번 사용될 수 있습니다.

•

GitHub Marketplace 및 커뮤니티에서 다양한 액션을 찾고 사용할 수 있습니다.

•

워크플로우 파일에서 액션을 호출하여 코드 빌드, 테스트, 배포 등의 작업을 구성할 수 있습니다.

WorkFlow 설정파일

./gitbub/workflows/main.yml

./gitbub/workflows/main.yml 은 workflow 의 설정파일입니다.

여기서, Job, Step, Actions 을 정의합니다.

workflow 설정파일 예시

•

main.yml

name: CI/CD Pipeline  # 워크플로우의 이름

on:
  push:  # 푸시 이벤트를 감지
    branches:
      - main  # main 브랜치에 푸시 이벤트 발생 시 워크플로우 실행

jobs:
  build:
    runs-on: ubuntu-latest  # 러너 환경을 ubuntu-latest 지정, 
  # runs-on: self-hosted  # 자신의 서버에서 직접 호스팅하는 경우

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2  # GitHub에서 제공하는 Checkout 액션을 사용하여 리포지토리 체크아웃

      - name: Setup Java
        uses: actions/setup-java@v2  # Java 환경 설정 액션 사용
        with:
          distribution: 'adopt'  # AdoptOpenJDK를 사용
          java-version: '11'  # Java 11 버전 사용

      - name: Build with Gradle
        run: ./gradlew clean build  # Gradle 빌드 명령 실행

      - name: Archive Artifacts
        uses: actions/upload-artifact@v2  # GitHub에서 제공하는 아티팩트 업로드 액션 사용
        with:
          name: app-artifacts  # 업로드한 아티팩트의 이름
          path: build/libs  # 업로드할 디렉토리 지정

  deploy:
    needs: build  # deploy 잡은 build 잡이 성공적으로 완료되어야 함
    runs-on: ubuntu-latest  # 배포 잡이 실행될 러너 환경을 ubuntu-latest로 지정

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2  # GitHub에서 제공하는 Checkout 액션을 사용하여 리포지토리 체크아웃

      - name: Download Artifacts
        uses: actions/download-artifact@v2  # GitHub에서 제공하는 아티팩트 다운로드 액션 사용
        with:
          name: app-artifacts  # 다운로드할 아티팩트의 이름

      - name: Deploy to Server
        run: |
          # 여기에 서버 배포 스크립트 또는 명령어 작성
          # 다운로드한 아티팩트(build/libs 디렉토리)를 활용한 배포 작업 수행
Bash
복사

Runner (러너)

Github Actions(Workflows) 작업을 실행하는 환경

종류

•

Github Hosted Runner

•

Self-Hosted Runner

Github Hosted Runner

Github 에 호스팅 되어 있는 Gtihub Actions 실행환경입니다.

Github Actions 의 이벤트를 감지하고, main.yml 에 미리 정의한 프로세스를 실행합니다.

생성하기

Settings

Actions

Runners

[New Runner]

Self-Hosted Runner

사용자가 직접 호스팅하고 관리하는 Github Actions 실행 환경입니다.

•

사용자는 자체 하드웨어 또는 클라우드에서 러너를 설정하고 GitHub에 등록합니다.

•

회사 내부 네트워크에 있는 리소스에 접근할 수 있으므로 민감한 데이터 또는 환경에서도 사용할 수 있습니다.

•

GitHub이 제공하는 다양한 실행 환경뿐만 아니라 사용자 정의 환경도 사용할 수 있습니다.

생성하기

Settings

Actions

Runners

[New Runner]

[Create Self-hosted Runner]

운영체제 지정

ii.

아키텍처 지정

iii.

Download, Configure 명령어 순서대로 실행

(LINUX 기준)

Download

# Create a folder
$ mkdir actions-runner && cd actions-runner# Download the latest runner package
$ curl -o actions-runner-linux-x64-2.311.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.311.0/actions-runner-linux-x64-2.311.0.tar.gz# Optional: Validate the hash
$ echo "??????????????????????????? actions-runner-linux-x64-2.311.0.tar.gz" | shasum -a 256 -c# Extract the installer
$ tar xzf ./actions-runner-linux-x64-2.311.0.tar.gz
Bash
복사

Configure

# Create the runner and start the configuration experience
$ ./config.sh --url https://github.com/ALOHA-CLASS --token ???????????????????????? Last step, run it!
Bash
복사

Run (실행)

./run.sh

등록 확인

My Git Repository

Settings

Actions

Runners

Artifact (아티팩트)

워크플로우에서 생성된 파일 또는 빌드 결과물을 저장하고 다른 잡에서 사용할 수 있게 하는 방법을 제공하는 요소

워크플로우의 여러 단계 간에 데이터를 전달하는 데 사용됩니다.

실습

.gitbub/workflows/main.yml 파일 생성

워크 플로우 정의하기

start.sh 배포 스크립트 작성

리눅스 서버에 self-hosted runner 설치 및 실행

서버에 git clone 하기

개발 PC 에 git clone 하기

개발 PC 에서 수정한 코드 git push 하기

서버에서 자동 빌드 및 배포 확인하기

.gitbub/workflows/main.yml 파일 생성

Repository

Actions

New workflow

set up a workflow yourself

워크 플로우 정의하기

•

main.yml 만으로 동작하는 버전

•

main.yml 와 start.sh 로 동작하는 버전

main.yml (build & deploy)

name: CI/CD Pipeline

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: self-hosted

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2

      - name: permission check
        run: chmod -R 777 .

      - name: Build with Gradle
        run: ./gradlew clean build

  deploy:
    needs: build
    runs-on: self-hosted

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v2

      - name: Deploy to Server
        run: |
          echo "> 새로운 애플리케이션 배포"
          # cd $GITHUB_WORKSPACE/build/libs
          cd /home/joeun/workspace/HelloSpringBoot/build/libs
          
          # 서버 실행
          echo "> 서버 실행"
          nohup java -jar "hello-application.war" &
Bash
복사

main.yml (with start.sh)

name: CI/CD Pipeline

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: self-hosted

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

    # - name: deploy to server
    - name: deploy to server
      run:  |
            sudo ./start.sh 
            sleep 5
Bash
복사

start.sh 배포 스크립트 작성

start.sh

#!/bin/bash

# 변수 선언 (=) 앞뒤로 공백❌
PROJECT_NAME=hello-application
WORKSPACE=/home/joeun/workspace
REPOSITORY=/home/joeun/workspace/HelloSpringBoot
DEPLOY_PATH=/home/joeun/workspace/HelloSpringBoot/build/libs

# 프로젝트 경로로 이동
echo "> ${REPOSITORY} 로 이동"
cd $REPOSITORY

# GIT PULL 진행
echo "> GIT PULL"
if git pull; then
  echo "> git pull 성공"
else
  echo "> git pull 실패"
  exit 1
fi

# 빌드 시작
echo "> gradle clean build"
./gradlew clean build 

# 현재 실행 중인 서버 pid(프로세스 아이디) 확인
CURRENT_PID=$(pgrep -f "${PROJECT_NAME}.war")

echo "> 현재 실행 중인 서버 pid : ${CURRENT_PID}"

# 실행 중인 서버 있는지 확인
if [ -z "$CURRENT_PID" ]; then
  echo "> 현재 실행 중인 서버 없음"
else
  echo "> 현재 실행 중인 서버 종료"
  kill -15 $CURRENT_PID
  sleep 5
fi

# 애플리케이션 재배포
echo "> 새로운 애플리케이션 배포"
cd $DEPLOY_PATH

nohup java -jar "${PROJECT_NAME}.war" &
Bash
복사

리눅스 서버에 self-hosted runner 설치 및 실행

runner 설치

Settings

Actions

Runners

[New Runner]

[Create Self-hosted Runner]

운영체제 지정

ii.

아키텍처 지정

iii.

Download, Configure 명령어 순서대로 실행

(LINUX 기준)

Download

# Create a folder
$ mkdir actions-runner && cd actions-runner# Download the latest runner package
$ curl -o actions-runner-linux-x64-2.311.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.311.0/actions-runner-linux-x64-2.311.0.tar.gz# Optional: Validate the hash
$ echo "??????????????????????????? actions-runner-linux-x64-2.311.0.tar.gz" | shasum -a 256 -c# Extract the installer
$ tar xzf ./actions-runner-linux-x64-2.311.0.tar.gz
Bash
복사

Configure

# Create the runner and start the configuration experience
$ ./config.sh --url https://github.com/ALOHA-CLASS --token ???????????????????????? Last step, run it!
Bash
복사

runner 실행

cd ~/workspace/actions-runner
Bash
복사

Bash
복사

서버에 git clone 하기

cd ~/workspace
Bash
복사

git clone https://github.com/ALOHA-CLASS/HelloSpringBoot.git
Bash
복사

개발 PC 에 git clone 하기

git clone https://github.com/ALOHA-CLASS/HelloSpringBoot.git
Bash
복사

개발 PC 에서 수정한 코드 git push 하기

코드 수정 및 푸시

Bash
복사

git commit -m '커밋'
Bash
복사

Bash
복사

서버에서 자동 빌드 및 배포 확인하기

개발PC 에서 PUSH

GitHub Actions Runner 에서 이벤트 감지

build

deploy