Garden项目中的Action版本与构建发布信息增强方案

背景介绍

在CI/CD流水线中使用Garden作为构建工具时，开发团队通常需要获取模块或Action的详细构建信息，包括版本号、发布标识等关键数据。这些信息对于后续的部署流程至关重要，特别是在需要将构建产物发布到其他非Garden管理环境时。

现有问题分析

在Garden的模块(Module)系统中，通过garden get modules命令可以方便地获取包括版本信息(version)、发布许可(allowPublish)和镜像名称(image)在内的完整构建元数据。然而，当用户迁移到更现代的Action系统后，发现garden get actions命令的输出缺少这些关键字段，即使使用--detail详细模式也无法获取。

技术方案设计

核心需求

1. 版本信息展示：需要包含完整的版本字符串(versionString)，这是Garden用于标记已发布镜像的重要标识
2. 发布控制信息：需要明确显示allowPublish标志，指示该Action是否允许发布
3. 发布标识符：需要包含publishId字段，显示Garden用于发布的镜像名称

实现方案

在Garden核心代码中，主要修改点位于core/src/commands/get/get-actions.ts文件。具体实现包括：

1. 扩展GetActionsCommandResultItem接口，新增三个可选字段：

interface GetActionsCommandResultItem {
  version?: ActionVersion
  allowPublish?: boolean
  publishId?: string
}

2. 在getActionsOutput方法中，当检测到详细输出模式(isOutputDetailed)时，填充这些新增字段：

version: a.getFullVersion(),
allowPublish: a.getConfig().allowPublish ?? undefined,
publishId: a.getSpec("publishId") ?? undefined,

新旧系统对比

模块(Module)系统输出示例

{
  "name": "example-build-image",
  "allowPublish": false,
  "version": {
    "contentHash": "dc87bafc70",
    "versionString": "v-6da1e19824"
  },
  "outputs": {
    "local-image-name": "example-build",
    "local-image-id": "example-build:v-6da1e19824"
  }
}

当前Action系统输出

{
  "name": "example-build-image",
  "kind": "Build",
  "type": "container",
  "disabled": false
}

改进后Action系统输出

{
  "name": "example-build-image",
  "kind": "Build",
  "type": "container",
  "disabled": false,
  "version": {
    "versionString": "v-6768e0d5e6"
  },
  "allowPublish": false,
  "publishId": "example-build"
}

技术价值分析

这一改进为Garden用户带来了以下技术优势：

1. 平滑迁移：从模块系统迁移到Action系统的用户可以获得一致的构建信息访问能力
2. 自动化支持：CI/CD流水线可以继续依赖Garden输出的结构化数据实现自动化部署
3. 调试便利：开发者可以更方便地查看和理解Action的构建和发布配置
4. 系统集成：与其他系统集成时，可以获取完整的构建元数据

实现建议

对于需要在项目中实现类似功能的开发者，建议：

1. 版本信息一致性：确保versionString的生成算法与模块系统保持一致，避免破坏现有工作流
2. 空值处理：对于可选字段(如publishId)，应妥善处理未配置的情况，避免输出null值
3. 文档更新：同步更新相关命令行帮助文档，说明新增的输出字段
4. 兼容性考虑：保持与非详细模式输出的兼容性，避免影响现有脚本

这一改进显著提升了Garden Action系统在CI/CD场景下的实用性，使得构建和发布信息的获取更加全面和一致。