Pages 技能用于把静态站点复制到本仓库的 gh-pages 分支,使其获得一个公开 URL。
用途: 将静态站点托管在本仓库的 GitHub Pages 上。适用于上传包含 index.html 的文件夹(包括 comprehende 导出结果),或当某个拉取请求需要预览页面时使用。
使用方式:
- 托管前先确认目标文件夹中存在 index.html。当该文件存在时即视为满足条件。如果缺失,则使用构建后的站点(comprehende 导出产物中的 out 目录)。
- 选择目标(dest)。如果指定了某个拉取请求名称,或者要托管该评审,可使用 gh pr view --json number 获取编号并配合 --pr 使用;其他情况使用 --name 并附带指定的小写 slug,或自行生成一个。当 --pr 或 --name 中恰好只有一个被确定时即完成。
- 在 comprehende 检出目录中运行 pnpm exec tsx scripts/pages-review.ts publish --dir <folder>,并带上该目标参数。--dir 可以位于工作树之外。其他参数可通过 pnpm exec tsx scripts/pages-review.ts --help 查看。当命令打印出一个 URL 时即完成。
- 将该 URL 提供给用户。
限制与说明: 如果访问该 URL 出现 404,说明 Pages 未开启。需要在 GitHub 仓库中一次性启用:Settings、Pages、Deploy from a branch、选择 gh-pages、目录选择 /。此时发布本身其实已经成功。