GithubAction을 이용한 CD (feat: appleboy/ssh-actions@master)

CD를 하면 보통 codeploy를 이용해 많이 하는 것 같던데 다른 방법 역시 기록해보고자 한다. 서버에 ssh로 접속하여 지정된 명령어를 연속해서 실행해주는 작업을 자동화 하는 방법을 기록한 글이다. 이 방법은 안전하고 공식적인 방법이라기 보다는 야매 느낌이 강하지만 일단 돌아가도록 하는 데에 관심이 있는 사람을 위해 그 방법을 기록해보고자 한다.

 

사전 요구 사항

EC2 및 배포할 코드

EC2 password로 접속하는 설정

 

 

상황

나의 경우 서버에 접속해서 실행되어야 하는 명령어는 아래와 같다.

pm2 kill
rm -rf dist  //타입스크립트 빌드 파일 삭제
git pull origin main //이후 비밀번호 입력
yarn run buildOnly  //타입스크립트 파일 빌드
pm2 start dist

 

최종적으로 완성된 모습은 다음과 같을 것이다. 깃헙 액션에는 서버에 ssh접속을 하는 것을 돕는 workflow가 있다. 이것을 이용해서 서버에 접속한 뒤, 위 명령어들을 차례로 실행할 것이다. 그러기 위해 3가지 단계로 나누어 진행할 것이다.

1. appleboy/ssh-action@master를 이용해 서버 접속
2. git credential를 이용해 비밀번호 입력 과정 스킵
3. 위에 적혀있는 명령어 실행

 

appleboy/ssh-action@master를 이용해 서버 접속

먼저 서버에 접속해보도록 하자. 상세한 옵션은 아래 링크에서 확인할 수 있다.

https://github.com/appleboy/ssh-action

GitHub - appleboy/ssh-action: GitHub Actions for executing remote ssh commands.

먼저 자신의 깃헙 레포에 루트 디렉토리에서 .github/workflows폴더 안에 yaml파일을 하나 생성하도록 하자. 이름은 마음대로 해도 된다. 나는 deploy.yaml파일을 만들었다.

name: deploy

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
jobs:
  AUTO_DEPLOY:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2   //point 1
      - name: Run scripts in server
        uses: appleboy/ssh-action@master. //point 2
        with:
          password: ${{ secrets.PASSWORD }}
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USER_NAME }}
          port: 22
          script: |
            //서버에 접속한 뒤 실행할 명령어들

위 파일에서 password, host, username은 깃헙 레포의 환경변수로 미리 등록해두어야 한다. password는 아래 글을 참고해서 password로 서버에 접속하는 설정을 해야한다.

AWS EC2 비밀번호로 접속하기

AWS EC2 비밀번호로 접속하기

비밀번호로 접근하는 설정을 했다면 아래 값들을 환경변수로 등록해주도록 하자.

password : 위에서 설정한 비밀번호
host : public IPv4 DNS값 (AWS console에서 확인 가능)
username : home/000에 들어가는 유저. 일반적으로 ubuntu이나 나는 ec2-user였음. ec2접속해서 폴더 이름을 확인해 알 수 있음

값들을 환경변수로 등록하는 방법은 아래와 같다.

Github action 환경 변수 등록

GitHub Actions - 환경변수 등록 방법

이제 다음 단계에서는 깃허브에서 클론을 받을 때 마다 비밀번호를 입력하는 과정을 생략해보도록 하자.

 

비밀번호 입력 과정 스킵

2가지 방법이 있다. 애초에 ec2에서 값을 클론받을 때 ssh로 클론받아도 되고 git credentials를 이용해도 된다. 여기서는 git credentials를 이용할 것이다. 방법은 간단하다. ec2에 접속한 뒤 아래 명령어를 실행시키면 된다.

git config --global credential.helper store

이렇게 한 뒤 비밀번호를 입력해주면 그 값이 저장되어 다음부터는 비밀번호를 입력받지 않는다.

 

명령어 입력

이제 서버에 접속했다고 가정하고 수행해야 할 코드들을 입력해주면 끝이 난다. 전체 deploy.yaml은 아래와 같다.

name: deploy

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]
jobs:
  AUTO_DEPLOY:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2   //point 1
      - name: Run scripts in server
        uses: appleboy/ssh-action@master. //point 2
        with:
          password: ${{ secrets.PASSWORD }}
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USER_NAME }}
          port: 22
          script: |
        	pm2 kill
		rm -rf dist  //타입스크립트 빌드 파일 삭제
		git pull origin main //git credentials에 의해 비밀번호 입력 과정 스킵
		yarn run buildOnly  //타입스크립트 파일 빌드
		pm2 start dist