用途
该技能用于在编写 Go 脚本时提供规范与操作指导,主要面向使用 Windmill 平台的开发场景。它规定了 Go 脚本应有的结构、入口函数与返回类型,并说明在本地迭代、测试、生成元数据与部署时应使用的 CLI 命令。
主要能力
- 说明 Go 脚本的包名必须为 inner,入口函数名为小写的 main,返回类型为 (返回值类型, error)。
- 返回类型可以是任何能序列化为 JSON 的 Go 类型。
- 错误处理通过第二个返回值返回,例如使用 errors.New 构造错误。
- 提供命令建议:wmill script preview、wmill script run、wmill generate-metadata、以及部署命令。
- 区分预览与运行的语义:有本地改动时优先使用 preview;仅在用户明确要求运行已部署版本时才使用 run。
- 维护元数据同步:改动脚本内容或 import 后,运行 wmill generate-metadata 更新 .lock、.script.yaml 输入 schema 与 wmill-lock.yaml 中的内容哈希。
- 支持 rehash 模式:当磁盘上的 .lock 与 .script.yaml 已正确,仅需刷新哈希时使用 wmill generate-metadata rehash。
- 提供 --dry-run 与路径参数、--strict-folder-boundaries 等方式来缩小元数据再生成范围。
- 提示依赖可能因重新解析而升级未固定版本,建议在部署前对比 .lock 变化并可在代码中固定版本。
- 指出 wmill resource-type list --schema 可发现可用资源类型。
- 如需在开发页面中以可视化方式打开脚本预览,可使用 preview 技能。
使用方式
将脚本放入某个文件夹中。编写完成后,根据用户意图提供对应命令建议。若用户尚未要求测试或运行,可用一句话提出下一步建议,而不是列出多选项菜单;若用户已要求测试或运行,则直接执行 wmill script preview <path> -d '<参数>',参数应依据脚本声明的参数选择合理取值。不同语言的参数形式不同:代码语言使用 main(...),SQL 使用各自占位符(如 PostgreSQL 的 $1、MySQL/Snowflake 的 ?、MSSQL 的 @P1、BigQuery 的 @name),Bash 使用位置参数 $1、$2 等,PowerShell 使用 param(...)。
适用场景
- 在 Windmill 项目中开发与迭代 Go 脚本。
- 在本地验证脚本是否可运行,而不希望覆盖工作区版本。
- 需要保持输入 schema、依赖锁与内容哈希同步,避免 git-sync 或 CI 出现无意义差异。
- 需要明确区分测试、预览与部署操作时。
限制与注意事项
- wmill script preview 不会部署,但仍会执行脚本代码并可能产生副作用;应在用户要求测试或确认执行意图后再运行。
- wmill generate-metadata 不会部署,只写入本地文件,但会重新解析依赖,可能提升未固定版本;默认应先向用户提出再运行,除非项目 AGENTS.md 明确允许自动执行。
- 部署到工作区(git push 或 wmill sync push)是唯一会修改远端状态的操作,仅在用户明确要求部署、发布或推送时执行。
- 若元数据再生成影响范围超出预期,可使用 --dry-run 查看每个过期项及原因,再用路径参数或 --strict-folder-boundaries 缩小范围。
- 资料未提供该技能的具体收费、价格或平台支持信息。