Github Actions CI&CD 파이프라인

# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: <https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs>

name: express CI & CD

# 어떤 이벤트가 발생했을 때. 다음 작업들을 실행할 것인지.
on:
  push:
    branches: [ "main" ]

jobs:
  # job 작업 단위
  build:
    # ubuntu 서버 환경 
    runs-on: ubuntu-latest 

    steps:
    # github Actions plugins. 또 다른 플러그인은 해당 링크에서 참조하여 사용할 수 있다. <https://github.com/marketplace>
    # github checkout plugins 및 Node 플러그인 사용
    - uses: actions/checkout@v4
    - uses: actions/setup-node@v4
      with:
        node-version: '18.x'
        cache: 'npm'
    # npm install과 동일한 기능을 수행하지만 속도가 더 바르기에 ci 사용
    - run: |
        npm ci
        npm run build --if-present
        # npm test


  deploy:
    runs-on: ubuntu-latest
    # needs는 작업의 작업 순서 방식을 의미한다. 동일한 서버 환경을 의미하지 않는다. test -> install -> build 순차적인 처리 순서를 의미한다.
    needs: build 

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      # SCP를 통한 배포 실행 
      - uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SERVER_IP }}
          username: ${{ secrets.SERVER_USER }}
          source: "./"   
          key: ${{ secrets.PEM }} 
          strip_components: 1
          target: ${{ secrets.SERVER_DIR }}

  debug: 
    needs: [install, deploy]
    runs-on: ubuntu-latest
    if: ${{ failure() }}
    steps:
      - run: echo "Faild to CI"

다음과 같이 코드를 작성했다. 우선 Git에 코드가 올라오면 npm 설치 및 테스트, 빌드를 실행한다. 그 이후에는 SCP를 통해 git 브랜치에 있는 파일을 전송한다. 노출이 되면 안돼는 값들은 github actions에 Secret을 사용했다.

 

CI 진행 중

잘못된 코드가 PUSH되었을 때 자동으로 배포가 안되게끔 해야한다.

 

CI 진행 후

해당 결과를 개발자에게 전달해줬으면 좋겠다.

 

배포 후
1.의존성을 빌드하고 실행시켜야 한다.
2.기존 프로세스를 죽이고 실행해야 한다.

 

name: CICD pipeline 

on:
  pull_request:
    types: [closed] 
    branches: [main]
  push:
    branches: 
    - main

jobs:
  build:
      defaults:
      run: 
        working-directory: ./test/

    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18.x] 

    steps:
    - uses: actions/checkout@v4
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v4
      with:
        node-version: ${{ matrix.node-version }}
        cache-dependency-path: './test/package-lock.json'
        cache: 'npm'

    - name: get dev .env
      run: |
        echo "${{ secrets.DEVELOPMENT_ENV }}" > ./.env    

    - name: npm install, build and test
      run: |
        npm ci
        npm run build --if-present
      # npm test

  deploy: 
    runs-on: ubuntu-latest
    needs: build 
    defaults:
      run: 
        working-directory: ./test/

    steps:
      - uses: actions/checkout@v4
      - uses: appleboy/scp-action@master
        with:
          host: ${{ secrets.SERVER_IP }}
          username: ${{ secrets.NODE_USER }}
          password: ${{ secrets.NODE_PASSWORD }} 
          source: "./"
          strip_components: 1
          target: ${{ secrets.SERVER_DIR }}

      - uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_IP }}
          username: ${{ secrets.NODE_USER }} 
          password: ${{ secrets.NODE_PASSWORD }} 
          script: |
            cd ${{ secrets.SERVER_DIR }}/test
            npm ci
            npm run build --if-present
            pm2 start ecosystem.config.js

 

Ref
https://docs.github.com/ko/actions/learn-github-actions/using-starter-workflows
https://velog.io/@oscar0421/github-action-빌드부터-배포까지
https://velog.io/@cataiden/ci-cd-with-github-actions-and-aws-codedeploy
https://medium.com/@ikbenezer/deploy-your-node-app-to-ec2-with-github-actions-364df98d9918
https://aws.amazon.com/ko/blogs/devops/integrating-with-github-actions-ci-cd-pipeline-to-deploy-a-web-app-to-amazon-ec2/