Repolode
제출하기
peaceiris

peaceiris/actions-gh-pages

워크플로에서 정적 사이트 빌드 결과물을 GitHub Pages 브랜치에 배포하는 GitHub Action입니다.

GitHub에서 보기웹사이트
스타
5,369
포크
448
열린 이슈
95
마지막 커밋
14시간 전

어떤 프로젝트인가요?

이 GitHub Action은 ./public이나 ./out 같은 빌드 결과 디렉터리의 내용을 GitHub Pages에서 사용하는 브랜치(기본값은 gh-pages)에 게시합니다. Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt, VuePress 등 일반 파일을 생성하는 모든 정적 사이트 생성기와 함께 사용할 수 있어, 기존 워크플로에서 빌드 단계 다음에 배포 단계를 추가하면 됩니다.

인증에는 현재 저장소용으로 자동 생성되는 GITHUB_TOKEN, SSH deploy key 또는 personal access token을 사용할 수 있습니다. external_repository 옵션으로 다른 저장소에 게시하려면 personal access token이나 deploy key가 필요합니다. 그 밖에도 대상 브랜치, 배포할 하위 디렉터리, 제외할 파일, CNAME 파일 추가, Jekyll 처리 제어, 기존 파일 유지, force-orphan 브랜치, 커밋 작성자와 메시지 설정, Git 태그 생성 등의 옵션을 제공합니다.

Linux, macOS, Windows 러너에서 실행되며, 버전 2.22.6 이상의 GitHub Enterprise Server를 지원합니다.

핵심 기능

  • 01정적 빌드 결과 디렉터리를 GitHub Pages 브랜치에 배포합니다.
  • 02GITHUB_TOKEN, SSH deploy key, personal access token을 지원합니다.
  • 03별도의 외부 저장소에 게시할 수 있습니다.
  • 04CNAME 파일, Jekyll 처리 비활성화, 배포에서 제외할 파일을 설정할 수 있습니다.
  • 05기존 파일을 유지하거나 커밋 하나만 있는 orphan 브랜치를 만들 수 있습니다.
  • 06Linux, macOS, Windows 러너에서 실행됩니다.

활용 사례

  • main에 푸시할 때마다 Hugo 또는 MkDocs 문서 사이트를 자동으로 게시합니다.
  • CI에서 Next.js 또는 Nuxt 정적 내보내기 결과물을 GitHub Pages에 배포합니다.
  • personal access token을 사용해 비공개 소스 저장소에서 공개 사이트를 게시합니다.
  • 생성된 사이트를 정기적으로 다시 빌드하고 배포합니다.

빠른 시작

  1. 1

    워크플로 파일 .github/workflows/gh-pages.yml을 추가하고 기본 브랜치에 push합니다

  2. 2

    deploy 단계를 사용해 빌드 출력 디렉터리를 게시합니다

    uses: peaceiris/actions-gh-pages@v4

사용 전 알아둘 점

  • GITHUB_TOKEN을 사용한 첫 배포 전에 저장소의 Pages 설정을 구성해야 합니다.
  • deploy_key 옵션은 Windows 러너에서 작동하지 않으므로 Windows 러너에는 배포 키가 필요합니다.

포함된 컬렉션

테스트 프레임워크 & 자동화 테스트 도구정적 사이트 생성기 및 문서 도구

토픽

#github-actions#github-pages#static-site#deployment#ci-cd#ssg#actions#gatsby#hugo#mdbook

자주 묻는 질문

actions-gh-pages은(는) 무엇인가요?
워크플로에서 정적 사이트 빌드 결과물을 GitHub Pages 브랜치에 배포하는 GitHub Action입니다. 이 GitHub Action은 ./public이나 ./out 같은 빌드 결과 디렉터리의 내용을 GitHub Pages에서 사용하는 브랜치(기본값은 gh-pages)에 게시합니다. Hugo, MkDocs, Gatsby, mdBook, Next.js, Nuxt, VuePress 등 일반 파일을 생성하는 모든 정적 사이트 생성기와 함께 사용할 수 있어, 기존 워크플로에서 빌드 단계 다음에 배포 단계를 추가하면 됩니다.
actions-gh-pages은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
actions-gh-pages은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
actions-gh-pages은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. actions-gh-pages의 마지막 커밋은 2026년 11월 6일입니다.
actions-gh-pages은(는) 어디에 사용할 수 있나요?
main에 푸시할 때마다 Hugo 또는 MkDocs 문서 사이트를 자동으로 게시합니다. CI에서 Next.js 또는 Nuxt 정적 내보내기 결과물을 GitHub Pages에 배포합니다. personal access token을 사용해 비공개 소스 저장소에서 공개 사이트를 게시합니다. 생성된 사이트를 정기적으로 다시 빌드하고 배포합니다.
actions-gh-pages는 어떻게 설치하나요?
워크플로 파일 .github/workflows/gh-pages.yml을 추가하고 기본 브랜치에 push합니다 deploy 단계를 사용해 빌드 출력 디렉터리를 게시합니다: uses: peaceiris/actions-gh-pages@v4
actions-gh-pages은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/peaceiris/actions-gh-pages

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트