peaceiris/actions-gh-pages

GitHub Actions에서 정적 사이트를 GitHub Pages로 배포하는 액션

설치형 도구맘대로 써도 됨 · MIT웹·Next.js·풀스택TypeScript난이도
5,324+5이번 주0
450포크59이슈

중간맛 분석

TypeScript로 작성된 GitHub Actions 액션입니다. 여러 정적 사이트 생성기(Hugo, Gatsby, MkDocs, mdBook, Next.js, Nuxt 등)를 지원하며, 기본 GITHUB_TOKEN, SSH Key, Personal Access 세 가지 인증 방식을 제공합니다. Ubuntu, macOS, Windows 모든 환경에서 작동하고, GitHub Enterprise Server도 지원합니다. 복잡한 사전 설정 없이 publish_dir만 지정하면 배포되므로 바로 실용적입니다.

이런 레포예요

이럴 때 쓰면 좋아요

  • Hugo/Gatsby/Next.js 등으로 만든 블로그나 문서 사이트를 main 브랜치 푸시 시 자동 배포
  • 팀 문서나 기술 블로그를 GitHub Pages로 호스팅하며 CI/CD 파이프라인 구축
  • 개인 포트폴리오 사이트를 정적 생성기로 관리하고 한 번의 커밋으로 반영

핵심 기능

여러 인증 방식 지원 (GITHUB_TOKEN, SSH Deploy Key, Personal Token)Hugo, Gatsby, Next.js, Nuxt 등 다양한 정적 사이트 생성기 호환외부 리포지토리 배포, 서브디렉토리 배포, CNAME 설정 등 고급 옵션

대안 대비 차별점

공식 GitHub Pages Action이 출시되었으나, 이 액션은 더 유연한 토큰 관리(SSH 지원), 외부 리포지토리 배포, 세밀한 배포 옵션(keep_files, exclude_assets, destination_dir 등)을 제공하며 5000+ 스타를 받은 커뮤니티 표준입니다.

먹어본 사람들

실제로 차려 먹어본 손님들의 흔적이에요 — 한마디와 완주 인증 모두 검수 후 공개돼요.

시식평 · 먹어본 사람 한마디

아직 시식평이 없어요. 먹어보셨다면 첫 한마디를 남겨주세요.

다른 레포 시식평 구경하기 →

이 레포로 만든 것들

🖋 완주 인증하기

아직 이 레포로 만든 완주 인증이 없어요. 첫 밥도장을 찍어보세요!

이 레포, 해먹는 법

처음 오셨어요? 어렵지 않아요 — 위에서 아래로 따라 하면 내 컴퓨터에 이 레포를 차려서 바로 맛볼 수 있어요.

준비물

  • GitHub 리포지토리
  • 정적 사이트 생성기 (선택사항: Hugo, Gatsby, Next.js 등)
  • GitHub Actions 실행 권한

바로 차려먹기Node.js (npm)

깃밥이 레포 구조를 확인하고 만든 실행 명령이에요. 터미널에 붙여넣으면 받기부터 실행까지 한 번에 진행돼요.

git clone --depth 1 https://github.com/peaceiris/actions-gh-pages.git &&
cd actions-gh-pages &&
npm install

실행 명령은 README를 확인하세요.

코드는 내 컴퓨터에서 실행돼요 — 처음 보는 레포라면 내용을 한번 훑어보고 실행하는 습관을 추천해요.

README가 안내하는 자세한 단계 보기
  1. 레포지토리 루트에 .github/workflows/gh-pages.yml 파일 생성:
mkdir -p .github/workflows
  1. 워크플로우 파일 작성 (Hugo 예시):
name: GitHub Pages

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  deploy:
    runs-on: ubuntu-22.04
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true
          fetch-depth: 0

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.110.0'

      - name: Build
        run: hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref == 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public
  1. 레포지토리 Settings > Pages에서 GitHub Pages 브랜치를 gh-pages로 설정

  2. 변경사항을 main 브랜치에 푸시:

git add .github/workflows/gh-pages.yml
git commit -m "Add GitHub Pages deployment workflow"
git push origin main
  1. GitHub Actions 탭에서 워크플로우 실행 확인

  2. 배포 완료 후 repository Settings > Pages에서 배포된 사이트 URL 확인

깃밥트라이로 맛보기

받아보기 귀찮고 살짝 불안했다면 — 안전 스캔부터 설치까지 터미널 한 줄로 끝나요.

터미널에 붙여넣으면 깃밥 안전 스캔 → 격리 폴더 clone → 설치 → 실행법 안내까지 자동이에요. 처음이어도 괜찮아요 — 이 한 줄이 전부예요.

npx gitbap-try peaceiris/actions-gh-pages

Node.js만 있으면 설치 없이 실행돼요 · 깃밥트라이가 뭐예요? →

별 추이 · 7일

5,324+5 / 7일

활용성 · 따라 만들기 좋은가

따라 하기 좋음샘플 점수 46/100
  • 관대한 라이선스
  • 테스트 있음
  • 예제 디렉토리
  • 최근 활동
  • AGENTS.md
  • llms.txt
  • 템플릿

🟢 최근 활동 있음 · 2019년 생성

「웹·Next.js·풀스택」 이런 레포, 매주 받아보실래요?

매주 월요일 아침, 골라 담은 밥상만. 광고 없이 · 언제든 해지.

내 레포인가요? README에 깃밥 배지 달기
[![깃밥](https://www.gitbap.com/badge/peaceiris/actions-gh-pages.svg)](https://www.gitbap.com/r/peaceiris/actions-gh-pages)
🔌 클로드에서 바로 써보기 — 깃밥 연결하는 법

깃밥을 클로드에 연결하면 이런 레포를 클로드·커서·Codex에서 바로 찾고 체험할 수 있어요.

방법 ① 커넥터 URL

클로드 설정 → 커넥터에 이 주소를 붙여넣기.

https://www.gitbap.com/api/mcp
방법 ② 플러그인 (체험까지)

플러그인을 설치하면 /gitbap-trending·/gitbap-try 슬래시 커맨드로 레포를 그 자리에서 체험. Claude Code에서 아래 두 줄을 차례로 실행하세요.

/plugin marketplace add jakeparkcolde/gitbap-cowork
/plugin install gitbap-cowork@gitbap
연결 방법 자세히 →

AI가 README 기반으로 요약했습니다 · 원문 보기