← 博客

把你的模板发布到 Registry:从目录到合并

模板是一个目录加一条索引记录。这篇按顺序讲清楚要建什么文件、本地怎么验证、提 PR 前自查什么,以及合并后多久能在 Registry 看到。

Registry 收录两类内容:模板和提供方。这篇只讲模板,提供方的流程见发布指南。

模板放在 awesome-templates 仓库。发布就是向这个仓库提一个 PR。

1. 建目录

在仓库根目录建一个 kebab-case 的目录。目录名、template.yaml 里的 name、索引里的 path 必须是同一个字符串。

my-template/
  template.yaml
  Dockerfile
  commands.py
  e2e_test.py
  README.md

template.yaml 里需要的密钥,只写变量名,值留空,不要提交真实密钥。

2. 写索引记录

在 awesome-templates.yaml 对应的分区加一条:name、description、repo、path、tags、author、capabilities、status。

status 取 official、community 或 experimental。社区提交从 community 开始。

3. 本地验证

在仓库根目录运行:

python3 scripts/run_local_e2e.py

每个带 commands.py 的模板都必须通过。

4. README 要说清三件事

模板是什么、怎么部署、怎么跑它的 e2e:

abx template install alibaba-agent-sandbox/awesome-templates//<name>
abx deploy
python3 scripts/run_local_e2e.py

5. 提 PR 前自查

  • 写明你验证了什么。没有真实后端可测,就在 README 里说明。
  • 声明的能力都真的实现了,没有声明的能力不要悄悄支持。
  • 没有写死的密钥,没有安装时执行的代码。
  • 每次更新都提高版本号。

合并之后

合并到 main 后,仓库会通知 Registry 重新构建;Registry 也会每小时自己拉取一次。可以在 Registry 的模板页确认,你的模板会带着能力标签和可复制的安装命令出现。

在自己的环境里试试

安装命令行,几分钟内创建第一个沙箱。

相关文章

官网和 Registry 改版:同一套设计,一个博客

官网和 Registry 现在用同一套设计系统、都有中英文,内容来自仓库里的真实数据。官网多了这个博客,用来放案例、教程和发布说明。

1 分钟阅读