跳转至

创建与发布 Agreement

Agreement 发布采用 asactl 的 CLI 构建工作流。

准备本地文件

  • ~/.asactl/build/agreement/{name}/{version}/agreement.json
  • ~/.asactl/build/agreement/{name}/{version}/meta.json(仅本地跟踪)

规则:

  • name:小写字母、数字、-,长度 3-30,且不能数字开头
  • version:带 v 前缀的精确版本号,例如 v1.0.0
  • agreement.json 中的 nameversion 要与目录一致

本地工作区里的文件角色:

  • agreement.json:必需,由你编写,会被发布
  • meta.json:可选,仅做本地跟踪,不参与发布

最小示例:

{
  "name": "sample-agreement",
  "version": "v1.0.0",
  "description": "描述业务场景与协议目的",
  "interface": {
    "userState": [],
    "functions": []
  }
}

构建与校验

asactl build agreement

发布前确认:

  • JSON 合法
  • 必填结构完整
  • 命名与版本一致

发布流程

目标仓库:

  • https://github.com/open-asa/asa.git

发布规则:

  • 仅发布 agreement.json
  • 不发布 meta.json
  • 目标路径:{name}/{version}/agreement.json

推荐 Git 流程:

  1. 同步上游 main
  2. 创建分支 agreement/{name}-{version}
  3. 仅提交目标 agreement.json
  4. push 并向 main 发 PR