深入理解GitHub复合动作：在自定义Node.js动作中调用其他动作

理解在自定义Node.js动作中调用其他动作的挑战

在开发基于javascript的github动作时，开发者可能希望在自定义逻辑执行之前，完成一些标准化的前置任务，例如检出代码仓库。然而，github的javascript动作本身是一个独立的执行单元，其内部通常不直接提供调用其他github动作的api或机制。如果直接在javascript代码中尝试调用actions/checkout，会发现这是行不通的，因为这些外部动作是作为工作流中的独立步骤运行的。

为了解决这一限制，我们需要一种方法来在自定义Node.js动作执行之前，编排并运行其他必要的GitHub动作。GitHub的“复合动作”正是为此类场景设计的强大工具。

复合动作（Composite Action）解决方案

复合动作允许你将多个工作流步骤（包括调用其他动作和运行脚本）封装成一个单一的、可复用的动作。通过这种方式，我们可以创建一个主复合动作，它负责按顺序执行前置动作（如代码检出），然后调用我们真正的自定义Node.js动作。

1. 复合动作的结构

复合动作的定义也通过一个action.yaml文件实现，但其runs部分使用using: "composite"来指定。以下是一个示例，展示了如何创建一个复合动作来先检出仓库，然后调用一个位于子目录中的Node.js动作：

name: '复合动作与嵌入式Node.js动作'
description: '在Node.js动作中使用其他动作的方法'
author: '您的GitHub用户名' # 替换为您的用户名
inputs:
  input1:
    required: false
    description: '传递给Node.js动作的示例输入'
runs:
  using: "composite"
  steps:
    - name: 检出Git仓库
      uses: actions/checkout@v3

    - name: 调用位于./actions/node-action目录的Node.js动作
      uses: ./actions/node-action
      with:
        input1: ${{ inputs.input1 }}

代码解析：

• name, description, author: 标准的动作元数据。
• inputs: 定义了复合动作可以接受的输入。这里input1是一个示例，它将被传递给内部的Node.js动作。
• runs.using: "composite": 明确指出这是一个复合动作。
• steps: 定义了复合动作将按顺序执行的一系列步骤。
  • 第一个步骤使用actions/checkout@v3来检出仓库。这是许多GitHub动作的常见前置条件。
  • 第二个步骤uses: ./actions/node-action是关键。它调用了位于当前仓库内./actions/node-action路径下的另一个动作。这个子动作就是我们的自定义Node.js动作。
  • with部分用于将复合动作接收到的输入（inputs.input1）传递给内部的Node.js动作。

2. 目录结构

为了使上述复合动作能够正确找到并调用内部的Node.js动作，文件系统需要遵循特定的结构。通常，自定义Node.js动作会放在复合动作定义文件（action.yaml）的子目录中。

├── action.yaml               # 这是主复合动作的定义文件
└── actions
    └── node-action
        └── action.yaml       # 这是自定义Node.js动作的定义文件
        └── index.js          # 这是自定义Node.js动作的JavaScript代码
        └── package.json      # Node.js动作的依赖管理

在这个结构中：

千面视频动捕

千面视频动捕是一个AI视频动捕解决方案，专注于将视频中的人体关节二维信息转化为三维模型动作。

27

查看详情

• 顶层的action.yaml是复合动作的定义。
• actions/node-action/action.yaml是你的Node.js动作的定义文件（它会指向index.js作为入口点）。

3. 自定义Node.js动作（actions/node-action/action.yaml）示例

为了完整性，这里提供一个简单的Node.js动作定义示例：

# actions/node-action/action.yaml
name: '我的自定义Node.js动作'
description: '一个简单的Node.js动作示例'
inputs:
  input1:
    required: false
    description: '从复合动作接收的输入'
runs:
  using: 'node16' # 或 'node20'
  main: 'index.js'

相应的index.js（Node.js动作的实际逻辑）可以这样获取输入：

// actions/node-action/index.js
const core = require('@actions/core');

async function run() {
  try {
    const input1 = core.getInput('input1');
    core.info(`Hello from Node.js action! Received input1: ${input1 || '未提供'}`);
    // 在这里执行你的Node.js逻辑
  } catch (error) {
    core.setFailed(error.message);
  }
}

run();

适用场景与注意事项

适用场景：

• 前置条件设置： 当你的自定义动作需要特定的环境或文件（如检出代码、安装依赖、配置环境变量）才能运行时，复合动作是理想的编排工具。
• 功能模块化： 将复杂的流程拆分为多个可复用的动作，并通过一个顶层复合动作进行组合。
• 简化工作流： 对于使用你自定义动作的用户来说，他们只需要调用你的复合动作，而无需关心内部的多个步骤。

注意事项：

• 路径管理： 确保复合动作中uses: ./path/to/your-action的路径是正确的，并且相对于复合动作的action.yaml文件。
• 输入/输出传递： 仔细规划复合动作与内部动作之间的输入和输出传递。复合动作可以通过其inputs接收参数，并通过outputs暴露结果。内部动作的输出可以通过id引用，并在复合动作的outputs中重新暴露。
• 版本控制： 如果你的Node.js动作和复合动作在同一个仓库中，它们通常会一起更新。如果它们是独立仓库，则需要像对待任何其他GitHub动作一样管理版本。
• 调试： 调试复合动作时，可以通过查看GitHub Actions工作流的日志来追踪每个步骤的执行情况。

总结

通过利用GitHub的复合动作，我们可以有效地将标准化的前置操作（如actions/checkout）与自定义的JavaScript（Node.js）动作结合起来。这种方法不仅解决了在Node.js动作中直接调用其他动作的限制，还提供了一种结构化、可维护的方式来构建复杂的GitHub Actions，极大地提升了动作的灵活性和复用性。掌握复合动作的使用，是编写高效、健壮GitHub Actions的关键技能之一。

以上就是深入理解GitHub复合动作：在自定义Node.js动作中调用其他动作的详细内容，更多请关注php中文网其它相关文章！