mcpField
D
deploy-docs

deploy-docs

github.com/everyinc云与 DevOps25.8k234 次安装今天更新
代码仓库

关于 deploy-docs

用于检查文档站点和部署前状态，并提供将文档发布到 GitHub Pages 的操作步骤。适合维护文档的开发者；涵盖文件验证、未提交改动检查和部署说明。

主要功能

  1. 01验证文档与 JSON 文件
  2. 02统计 Agent 和 Skill 数量
  3. 03检查文档目录的 Git 状态
  4. 04提供 GitHub Pages 部署步骤

适用场景

  1. 01部署前核对文档站点
  2. 02确认 JSON 配置有效
  3. 03发现尚未提交的文档改动
  4. 04设置 GitHub Pages 发布流程

安装

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

$npx skills add https://github.com/everyinc/compound-engineering-plugin --skill deploy-docs

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

详细介绍

部署文档命令

验证文档站点，并为部署到 GitHub Pages 做好准备。

第 1 步：验证文档

运行以下检查：

# Count components
echo "Agents: $(ls plugins/compound-engineering/agents/*.md | wc -l)"
echo "Skills: $(ls -d plugins/compound-engineering/skills/*/ 2>/dev/null | wc -l)"

# Validate JSON
cat .claude-plugin/marketplace.json | jq . > /dev/null && echo "✓ marketplace.json valid"
cat plugins/compound-engineering/.claude-plugin/plugin.json | jq . > /dev/null && echo "✓ plugin.json valid"

# Check all HTML files exist
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 exists"
  else
    echo "✗ ${page}.html MISSING"
  fi
done

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

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

如果存在未提交的更改，请提醒用户先提交。

第 3 步：部署说明

由于部署到 GitHub Pages 需要具有特殊权限的工作流文件，请提供以下说明：

首次设置
  1. 创建 .github/workflows/deploy-docs.yml，并写入 GitHub Pages 工作流
  2. 前往仓库的 Settings > Pages
  3. 将 Source 设置为 "GitHub Actions"
部署

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

  1. 前往 Actions 选项卡
  2. 选择 "Deploy Documentation to GitHub Pages"
  3. 点击 "Run workflow"
工作流文件内容
name: Deploy Documentation to 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 步：报告状态

提供摘要：

## Deployment Readiness

✓ All HTML pages present
✓ JSON files valid
✓ Component counts match

### Next Steps
- [ ] Commit any pending changes
- [ ] Push to main branch
- [ ] Verify GitHub Pages workflow exists
- [ ] Check deployment at https://everyinc.github.io/compound-engineering-plugin/

评论

支持 Markdown