GitHub Actions中github-script模块exec方法使用详解

在使用GitHub Actions自动化流程时，actions/github-script模块是一个非常实用的工具，它允许开发者在工作流中直接执行JavaScript代码。然而，许多开发者在尝试使用exec方法执行系统命令时遇到了困惑，本文将详细解析正确的使用方法。

常见误区分析

许多开发者会直接按照直觉编写如下代码：

- name: 执行命令示例
  uses: actions/github-script@v7
  with:
    script: |
      const result = await exec('echo', ['hello'])

这段代码会抛出"exec is not a function"的错误，这是因为对actions/github-script模块中exec的引用存在理解偏差。

正确使用方法

实际上，actions/github-script模块提供的exec是一个包含多个方法的对象，而非直接可用的函数。要执行系统命令，需要使用exec对象中的exec方法：

- name: 正确执行命令示例
  uses: actions/github-script@v7
  with:
    script: |
      const result = await exec.exec('echo', ['hello'])

技术原理

actions/github-script模块内部集成了GitHub Actions工具包中的@actions/exec包。这个包提供了在Actions环境中执行系统命令的能力，但需要通过对象方法调用的方式使用。

高级用法

除了基本的命令执行，exec对象还提供了其他有用的方法：

1. 获取命令输出：

script: |
  let output = ''
  await exec.exec('ls', ['-la'], {
    listeners: {
      stdout: (data) => {
        output += data.toString()
      }
    }
  })
  console.log(output)

2. 设置工作目录：

script: |
  await exec.exec('npm install', [], {
    cwd: './subdirectory'
  })

3. 处理退出码：

script: |
  try {
    await exec.exec('false')
  } catch (error) {
    console.log(`命令执行失败，退出码：${error.exitCode}`)
  }

最佳实践建议

1. 对于复杂命令，建议使用数组形式传递参数，避免shell注入风险
2. 重要的命令执行建议添加错误处理逻辑
3. 长时间运行的命令可以添加超时控制
4. 敏感信息应使用GitHub Secrets而非硬编码在脚本中

通过理解这些细节，开发者可以更高效地利用actions/github-script模块实现复杂的自动化工作流。