我和朋友开发了一个 GitHub action ,名叫 Stoat ,可以给 GitHub pull request 提供一站式服务。
文档: https://docs.stoat.dev/docs/intro
示例: https://github.com/stoat-dev/stoat-action/pull/43#issuecomment-1344719650
以上截图显示的是在 GitHub pull request 下,Stoat 以置顶评论的形式,显示的项目信息。目前主要开发了两个小组件:HTML 预览,以及 GitHub job 运行时间跟踪。
HTML 预览:可以上传并托管项目构建过程中生成的任意静态 HTML 文件或者文件夹。常见的使用场景包括:预览测试覆盖率报告、文档、前端 storybook 。
GitHub job 运行时间跟踪:为 pull request 中所有 GitHub workflow job 绘制运行时间变化图。常见的使用场景是,查看新的代码有没有给 job 运行时间带来意料之外的变化。
每次有新的 commit 和 GitHub workflow run ,pull request 上的这条评论都会自动更新。这种显示的形式类似 Vercel ,但是支持更多的功能。
以 Storybook 为例,假设现有一个前端项目,已经安装了 Storybook ,并且已存在一个 GitHub action ,会构建 Storybook 。那么可以使用方法如下:
.stoat/config.yaml
---
version: 1
enabled: true
tasks:
# 自定义的任务 ID
# 这是一个 HTML 托管任务
preview-storybook:
static_hosting:
# 构建好的 Storybook 的文件夹,通常是 storybook-static
path: storybook-static
# 这是一个 job 运行时间跟踪任务
track-build-time:
job_runtime:
# 这是现有的 workflow steps
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: 18
- name: Build Storybook
run: |
npm install
npm run build-storybook
# 在现有 workflow 末尾,添加 Stoat action
- name: Run Stoat Action
uses: stoat-dev/stoat-action@v0
if: always()
以上步骤的文档: https://docs.stoat.dev/docs/quick-start/storybook
更多示例: https://docs.stoat.dev/docs/category/quick-start
相比现有的各类托管 GitHub action ,这个项目的优势是:
项目是全英文开发,目前还没有中文文档,还请见谅。
感谢大家尝试使用!
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.