GitHub Actions로 SFTP 자동 배포 스크립트 만들기

SSH 키 발급용 질문 생성 프롬프트

단계 2: 워크플로우 스크립트 작성

내 프로젝트 루트 폴더에 .github/workflows/deploy.yml 파일을 만들고 아래 코드를 복사해 넣는다. 깃허브에서는 폴더 생성 기능이 따로 없고 파일 생성때 경로를 입력하면 해당 폴더들이 같이 생성되니 참고하도록 하자.

스크립트 01 : 붙여넣기 용

name: Deploy via SFTP

on:
  push:
    branches: [ "main" ] # main 브랜치에 푸시될 때 실행

jobs:
  ftp-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: SFTP Deploy
        uses: wlixcc/SFTP-Deploy-Action@v1.2.4
        with:
          username: ${{ secrets.FTP_USERNAME }}
          server: ${{ secrets.FTP_SERVER }}
          ssh_private_key: ${{ secrets.SFTP_SSH_KEY }}
          port: 22
          # 로컬의 전송할 폴더 경로
          local_path: ./test/
          # 서버의 배포 위치 (상대 경로 주의)
          remote_path: www/wp-content/themes/test/
      

스크립트 02 : 해설용

# 1. 워크플로우의 이름입니다. GitHub Actions 탭에서 이 이름으로 표시됩니다.
name: Deploy via SFTP

# 2. 이 스크립트가 언제 실행될지(트리거) 결정합니다.
on:
  push:
    # "main" 브랜치에 코드가 push(업로드)될 때마다 이 자동화가 시작됩니다.
    branches: [ "main" ]

# 3. 실제 수행할 작업들의 묶음입니다.
jobs:
  # 작업의 고유 ID입니다. 여기서는 'ftp-deploy'라고 정했습니다.
  ftp-deploy:
    # 이 작업이 실행될 가상 환경(서버)을 지정합니다. 
    # 최신 우분투 리눅스 환경에서 작업을 수행하겠다는 뜻입니다.
    runs-on: ubuntu-latest

    # 4. 작업의 세부 단계들입니다.
    steps:
      # [1단계] 현재 저장소(GitHub)에 있는 소스 코드를 가상 환경으로 가져옵니다.
      - name: Checkout code
        uses: actions/checkout@v3

      # [2단계] SFTP를 이용해 파일을 실제 서버로 전송합니다.
      - name: SFTP Deploy
        # 다른 개발자가 미리 만들어둔 'SFTP-Deploy-Action'이라는 도구를 가져다 씁니다.
        uses: wlixcc/SFTP-Deploy-Action@v1.2.4
        
        # 도구 실행에 필요한 설정값(입력값)들입니다.
        with:
          # GitHub Settings > Secrets에 저장한 서버 아이디를 가져옵니다.
          username: ${{ secrets.FTP_USERNAME }}
          
          # 서버 주소(IP 또는 도메인)를 보안 저장소에서 가져옵니다.
          server: ${{ secrets.FTP_SERVER }}
          
          # 가장 중요한 SSH 개인키입니다. 역시 보안 저장소에서 가져옵니다.
          ssh_private_key: ${{ secrets.SFTP_SSH_KEY }}
          
          # SFTP가 사용하는 기본 포트인 22번을 지정합니다.
          port: 22
          
          # [중요] 깃허브 저장소 내에서 서버로 보낼 폴더의 경로입니다.
          # 현재는 저장소 루트의 'test' 폴더만 보내도록 설정되어 있습니다.
          local_path: ./test/
          
          # [중요] 파일이 도착할 실제 서버의 경로입니다.
          # 카페24 같은 호스팅 서비스의 실제 테마 폴더 경로를 정확히 적어야 합니다.
          remote_path: www/wp-content/themes/test/

단계 3: 배포 확인 및 주의사항

경로 설정: remote_path를 설정할 때 서버의 루트 폴더가 어디인지 정확히 확인해야 한다. 잘 모르겠다면 본인의 호스팅 업체에 문의 하면 된다.
SSH Key 형식: 키 내용의 처음(—–BEGIN…)과 마지막(—–END…) 줄을 모두 포함해야 하며, 마지막에 빈 줄이 하나 포함되어야 오류가 없다. 그냥 메모장으로 파일 열고 Ctrl+A 한뒤에 그대로 붙여넣기 하고 아무것도 건드리지말고 저장하면 특별한 경우가 아니면 문제가 없을 것이다.

맺음말

이제 코드를 수정하고 git push만 하면, 자동으로 서버에 파일이 업로드된다. 매번 FTP 열고, 서버 접속해서 수정할 파일 찾아 백업하고 교체하고…그런 귀찮음은 끝이다. SFTP라서 보안도 아무 걱정 없다. 힘겹게(?) 코딩 하고 편안하게 배포하는 즐거움만 남을 것이다. 다음번에는 여기서 한 스텝 더 나아가서, 배포 완료 후 알림을 텔레그램으로 받는 방법에 대해서 소개하도록 하겠다.

1. Plain Text. 아스키 코드같은 단순한 문자로만 이뤄진 텍스트. 일체의 그림이나 코드 없이 맨눈으로 읽을수 있는 글자로만 이뤄져 있다. 당연히 암호화가 없으니 유출되기 쉽다. 흔히 TV에서 통신사 개인정보 유출 같은 뉴스가 나올때 잘 살펴보면 “해당 정보가 플레인 텍스트로 암호화되지 않아 피해가 더 커져…” 같은 내용을 볼 수 있다. ↩︎