GitHubPages文档部署Skill deploy-docs

---

name: 部署文档 description: 验证并准备文档以供GitHub Pages部署

部署文档命令

验证文档站点并准备它以供GitHub Pages部署。

第1步：验证文档

运行这些检查：

# 计数组件
echo "代理: $(ls plugins/compound-engineering/agents/*.md | wc -l)"
echo "命令: $(ls plugins/compound-engineering/commands/*.md | wc -l)"
echo "技能: $(ls -d plugins/compound-engineering/skills/*/ 2>/dev/null | wc -l)"

# 验证JSON
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json 有效"
cat plugins/compound-engineering/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json 有效"

# 检查所有HTML文件是否存在
for page in index agents commands skills mcp-servers changelog getting-started; do
  if [ -f "plugins/compound-engineering/docs/pages/${page}.html" ] || [ -f "plugins/compound-engineering/docs/${page}.html" ]; then
    echo "✓ ${page}.html 存在"
  else
    echo "✗ ${page}.html 缺失"
  fi
done

第2步：检查未提交的更改

git status --porcelain plugins/compound-engineering/docs/

如果有未提交的更改，警告用户先提交。

第3步：部署指令

由于GitHub Pages部署需要一个具有特殊权限的工作流程文件，提供这些指令：

首次设置

1. 创建 .github/workflows/deploy-docs.yml 并包含GitHub Pages工作流程
2. 前往仓库设置 > 页面
3. 设置源为“GitHub Actions”

部署

合并到 main 后，文档将自动部署。或者：

1. 前往操作选项卡
2. 选择“部署文档到GitHub Pages”
3. 点击“运行工作流程”

工作流程文件内容

name: 部署文档到GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - 'plugins/compound-engineering/docs/**'
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/configure-pages@v4
      - uses: actions/upload-pages-artifact@v3
        with:
          path: 'plugins/compound-engineering/docs'
      - uses: actions/deploy-pages@v4

第4步：报告状态

提供一个总结：

## 部署准备状态

✓ 所有HTML页面存在
✓ JSON文件有效
✓ 组件计数匹配

### 下一步
- [ ] 提交任何待处理的更改
- [ ] 推送到主分支
- [ ] 验证GitHub Pages工作流程存在
- [ ] 检查部署在 https://everyinc.github.io/every-marketplace/