mcpField
G
gh-pages-deploy

gh-pages-deploy

github.com/aviz85云与 DevOps50312 次安装16 周前更新
代码仓库

关于 gh-pages-deploy

使用 Git 和 GitHub CLI 将静态前端网站发布到 GitHub Pages 的命令行流程。涵盖仓库初始化、Pages 配置、部署状态检查和网站更新。

主要功能

  1. 01初始化并推送 Git 仓库
  2. 02使用 gh 创建 GitHub 仓库
  3. 03从 main 分支启用 Pages
  4. 04检查构建状态和站点 URL
  5. 05通过 Git 推送发布更新

适用场景

  1. 01发布静态前端项目
  2. 02为仓库配置 Pages
  3. 03发布后检查部署状态

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aviz85/claude-skills-library --skill gh-pages-deploy

安装后在 Claude Code 中输入/gh-pages-deploy确认已加载。

详细介绍

GitHub Pages 部署

使用 GitHub CLI 将静态前端网站部署到 GitHub Pages。

前提条件

  • 已安装并完成身份验证的 GitHub CLI（gh）
  • 已安装 Git
  • 已准备好待部署的前端项目（HTML、CSS、JS）

部署工作流

1. 初始化 Git 仓库（如有需要）
git init
git add .
git commit -m "Initial commit"
2. 创建 GitHub 仓库
# Create public repo (required for free GitHub Pages)
gh repo create <repo-name> --public --source=. --push
3. 启用 GitHub Pages
# Enable GitHub Pages from main branch root
gh api repos/{owner}/{repo}/pages -X POST -f build_type=legacy -f source='{"branch":"main","path":"/"}'

或者使用 docs 文件夹：

gh api repos/{owner}/{repo}/pages -X POST -f build_type=legacy -f source='{"branch":"main","path":"/docs"}'
4. 检查部署状态
# Get pages info
gh api repos/{owner}/{repo}/pages

# View deployment status
gh api repos/{owner}/{repo}/pages/builds/latest
5. 在仓库设置中设置主页 URL

务必执行此操作 — 将线上 URL 设置在 GitHub 仓库的「关于」面板中（仓库页面右上角）：

OWNER=$(gh api user --jq '.login')
PAGES_URL=$(gh api repos/$OWNER/$REPO_NAME/pages --jq '.html_url')
gh api --method PATCH repos/$OWNER/$REPO_NAME --field homepage="$PAGES_URL" --jq '.homepage'
6. 获取网站 URL

网站可通过以下地址访问：https://<username>.github.io/<repo-name>/

自动部署已启用：每次推送到 main 都会触发重新构建。旧版构建无需使用 GitHub Actions。

快速部署脚本

通过一个流程完成部署：

# Variables
REPO_NAME="my-site"

# Initialize and commit
git init
git add .
git commit -m "Initial commit"

# Create repo and push
gh repo create $REPO_NAME --public --source=. --push

# Enable pages
sleep 2
OWNER=$(gh api user --jq '.login')
gh api repos/$OWNER/$REPO_NAME/pages -X POST -f build_type=legacy -f source='{"branch":"main","path":"/"}'

# Set homepage URL in repo About panel
PAGES_URL="https://$OWNER.github.io/$REPO_NAME/"
gh api --method PATCH repos/$OWNER/$REPO_NAME --field homepage="$PAGES_URL" --jq '.homepage'

echo "✓ Site live at: $PAGES_URL"

故障排除

  • 未启用 Pages：确保仓库为公开仓库，或拥有 GitHub Pro
  • 404 错误：等待 1-2 分钟以完成部署，并检查根目录下是否存在 index.html
  • 构建失败：检查 GitHub Actions 选项卡中的错误

更新网站

完成更改后：

git add .
git commit -m "Update site"
git push

GitHub Pages 将自动重新构建。

评论

支持 Markdown