解决actions/upload-artifact中输出变量为空的问题

在使用GitHub Actions的actions/upload-artifact上传工件时，开发者可能会遇到一个常见问题：上传步骤的输出变量（如artifact-id和artifact-url）返回空值。本文将深入分析这个问题产生的原因，并提供完整的解决方案。

问题现象

当开发者尝试使用以下方式获取上传工件的ID和URL时：

steps:
  - name: Upload Artifact
    uses: actions/upload-artifact@v4
    with:
      name: Release
      path: /path/to/files
    env:
      MYID: ${{ steps.artifact-upload-step.outputs.artifact-id }}
      MYURL: ${{ steps.artifact-upload-step.outputs.artifact-url }}

发现MYID和MYURL环境变量始终为空，尽管在日志中可以看到上传成功的工件确实有ID和URL。

问题根源

这个问题的根本原因是步骤标识符（id）的缺失。在GitHub Actions中，要引用一个步骤的输出变量，必须满足两个条件：

1. 该步骤必须显式定义了一个唯一的id
2. 该步骤必须确实有输出变量

在上述例子中，上传步骤没有定义id，因此无法通过steps.artifact-upload-step.outputs来引用其输出。

正确配置方法

正确的配置应该为上传步骤添加一个明确的id，然后通过这个id来引用输出变量：

steps:
  - name: Upload Artifact
    uses: actions/upload-artifact@v4
    id: artifact-upload-step  # 关键：添加步骤ID
    with:
      name: Release
      path: /path/to/files
    env:
      GITHUB_TOKEN: ${{ github.token }}
  
  - name: Use Output Variables
    run: |
      echo "Artifact ID: ${{ steps.artifact-upload-step.outputs.artifact-id }}"
      echo "Artifact URL: ${{ steps.artifact-upload-step.outputs.artifact-url }}"

技术原理

GitHub Actions的工作流执行机制中，每个步骤都可以有输入和输出。要引用一个步骤的输出：

1. 步骤必须通过id字段明确标识自己
2. 步骤的输出变量通过outputs上下文提供
3. 引用格式为steps.<step-id>.outputs.<output-name>

actions/upload-artifact动作默认会输出以下变量：

• artifact-id：上传工件的唯一标识符
• artifact-url：工件的访问URL

最佳实践建议

1. 始终为需要引用的步骤添加id：这不仅限于上传工件步骤，任何可能被后续步骤引用的步骤都应明确标识。

2. 验证输出变量：可以通过简单的echo命令验证输出变量是否被正确设置。

3. 环境变量与直接引用的选择：虽然可以将输出保存到环境变量，但直接引用通常更清晰：

   - name: Build URL manually
     run: echo "Artifact URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts/${{ steps.artifact-upload-step.outputs.artifact-id }}"
   

4. 注意作用域：环境变量只在当前作业中有效，而输出变量可以通过needs上下文跨作业引用。

通过理解GitHub Actions的这些基本机制，开发者可以避免类似的问题，并构建出更可靠的工作流。