peaceiris/gh-pages

peaceiris/gh-pages镜像说明

镜像概述

本镜像提供GitHub Actions部署功能，用于将静态文件发布到GitHub Pages。目前已迁移至TypeScript版本（v3），对各类静态站点生成器友好，帮助用户快速完成站点部署。旧版Docker Action可参考v2分支。

核心功能

• 支持静态文件自动化部署到GitHub Pages
• 兼容Jekyll、Hugo等主流静态站点生成器
• 集成GitHub Actions工作流，简化部署配置
• 提供安全的身份验证方式（如GitHub Token）

使用场景

• 个人博客、项目文档站点的自动化发布
• 开源项目页面的更新与维护
• 静态网站（如营销页、作品集）的快速部署

配置说明

需在GitHub仓库的 workflows 文件中配置该Action，关键参数包括：

• github_token：GitHub身份验证令牌（需通过Secrets管理）
• publish_dir：静态文件所在目录（如./public）
• publish_branch：部署目标分支（默认gh-pages）

部署示例

在.github/workflows/deploy.yml中添加以下步骤：

yaml
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      
      - name: Build static files
        run: |
          # 替换为你的静态站点构建命令（如hugo build）
          hugo --minify
      
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public