SuperAPI AI 工具集

deploy-docs

部署与运维

查看项目

更新于 10-16 04:31

技能介绍

用途:校验文档站点并为其部署到 GitHub Pages 做好准备,适用于需要把插件文档发布到 GitHub Pages 的场景。

主要能力分四步。第一步校验文档:统计 agents 与 skills 组件数量,使用 jq 校验 marketplace.json 与 plugin.json 是否为合法 JSON,并检查 index、agents、commands、skills、mcp-servers、changelog、getting-started 等 HTML 页面是否存在。第二步检查未提交改动:运行 git status --porcelain plugins/compound-engineering/docs/,如有改动会提醒先提交。第三步给出部署说明:首次设置需创建 .github/workflows/deploy-docs.yml,并在仓库 Settings > Pages 中将 Source 设为 GitHub Actions;部署可在合并到 main 后自动触发,或在 Actions 标签页选择 "Deploy Documentation to GitHub Pages" 并点击 Run workflow。第四步输出部署就绪状态摘要与后续步骤清单。

工作流文件核心内容(需保持原样):权限为 contents: read、pages: write、id-token: write;在 push 到 main 且路径匹配 plugins/compound-engineering/docs/** 或手动触发时运行;步骤依次使用 actions/checkout@v4、actions/configure-pages@v4、actions/upload-pages-artifact@v3(path: 'plugins/compound-engineering/docs')、actions/deploy-pages@v4。

限制:GitHub Pages 部署需要具备特殊权限的工作流文件;资料未提供其他平台支持、收费信息或额外配置项。