GitHub Actions로 github.io에 자동으로 빌드, 배포하기

github.io 블로그에 글을 작성하고 매번 커밋 후에 직접 배포해야 하는 게 번거로울 것 같아서 자동으로 배포하는 방법을 찾아봤다.

자동 배포 방법은 Gatsby Publish를 사용해서 GitHub Actions를 생성하면 된다!

GitHub Actions 적용하기

GitHub Action으로 배포 자동화에서 'GitHub Action으로 배포 자동화' 부분을 참고했다.

적용 과정

 

1) 깃허브 Settings / Developer settings / Personal access tokens에서 토큰 생성

2) github.io 저장소 Settings / Secrets / Actions secrets에 생성한 토큰을 DEPLOY_TOKEN 이라는 이름으로 추가

3) github.io 저장소 Settings / Actions / General 에서 Actions permissions 설정 -> Allow all actions and reusable workflows 선택

 

 

4) github.io 저장소의 root 폴더에 .github/workflows/[파일명].yml 파일 생성

 

나는 deploy.yml이라는 이름으로 생성했고, 작성한 코드는 아래와 같다.

 

name: Gatsby Publish

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: enriikke/gatsby-gh-pages-action@v2
        with:
          access-token: ${{ secrets.DEPLOY_TOKEN }}
          deploy-branch: gh-pages

 

Gatsby Publish의 기본 코드는 Gatsby Publish 를 참고하면 된다.

 

• 기본 코드에서 수정한 부분
  • branches: - main : main 브랜치에 글을 커밋할 거라서 main으로 변경
  • uses: actions/checkout@v3 : checkout 버전을 3으로 변경
  • access-token: ${{ secrets.DEPLOY_TOKEN }} : 토큰 이름 변경 (변경 안해도 상관 x)
  • deploy-branch: gh-pages : 빌드 파일을 기본 브랜치가 아닌 gh-pages 브랜치에 업로드

 

main 브랜치에 push할 때마다 access-token을 이용해서 gh-pages 브랜치에 gatsby-gh-pages-action 실행

 

이라는 뜻!

 

(gh-pages 브랜치에 배포하기로 설정했으니 github.io 저장소 Settings / Pages 에 ‘gh-pages’ 브랜치로 선택되어 있어야 함)

모든 설정이 완료되면 이제부터 main 브랜치에 커밋할때마다 자동으로 github.io에 배포된다.

GitHub Action이 완료되기까지 시간이 살짝 걸림..!

여기까지는 문제없이 잘 따라했는데 처음에 Actions permissions 설정을 잘못해서 계속 에러가 났다.

 

위에 작성한 대로 Actions permissions 설정을 Allow all actions and reusable workflows 로 선택했더니 문제없이 잘 수행됐다.

 

배포 성공 기념 샷 ✌️