CI/CD / 知识点

GitHub Actions 工作流语法速查

步骤与 Action

使用 run 执行 Runner 上的 Shell 命令,可通过多行块组合脚本;不同操作系统默认 Shell 不完全一致,跨平台工作流应显式核对。

执行 Shell 命令

需要在 Runner 上直接执行构建、测试、文件处理或诊断命令时查 run。它把当前 Step 的脚本文本交给所选 Shell 执行;跨操作系统或依赖特定语法时,应显式设置 shell。

怎么判读

写法或线索 含义 建议动作
run: command 执行单条命令 适合短命令
run: | 执行多行脚本 把同一处理阶段放在一个 Step
shell: bash 明确使用 Bash 需要 Bash 语法或希望跨 Runner 保持一致时显式写出
未写 shell 使用该 Runner 的默认 Shell 跨 ubuntu、macos、windows 时不要假设行为完全一致
多个 run Step 每个 Step 启动独立的 Shell 进程 跨 Step 传值用 $GITHUB_ENV、Step 输出或文件,不要只靠 export

run 与 uses 表示两类不同的 Step 行为:一个 Step 通常执行脚本或调用 Action,不能把两者合并成同一个执行定义。

快速确认

下面的工作流可通过 Actions → 选择工作流 → Run workflow 手动触发,并显式使用 Bash:

yaml
name: run-demo

on:
  workflow_dispatch:

jobs:
  demo:
    runs-on: ubuntu-latest
    steps:
      - name: Execute shell commands
        shell: bash
        run: |
          set -euo pipefail
          message='hello-actions'
          echo "$message"
          echo "sum=$((2 + 3))"

预期输出:

text
hello-actions
sum=5

GitHub 日志还会包含 Runner 和 Step 自身的包装日志,具体前后缀会随 Runner 版本变化;确认这两行出现且 Step 为成功状态即可。

常见边界

多行 run 适合顺序执行的一组命令,但其中任一关键命令失败是否立即终止仍受 Shell 行为影响。对 Bash 可显式使用 set -euo pipefail,并避免把失败命令隐藏在不检查退出码的管道或条件中。

若命令需要在 Windows 上运行,应选择与脚本语法匹配的 shell,例如 pwsh;不要把 Bash 的变量、重定向或路径规则直接假定为 PowerShell 规则。

适用范围:GitHub Actions 工作流中的 jobs.<job_id>.steps[*].run。Runner 镜像内可用的命令、工具版本和默认 Shell 以所选 Runner 与 GitHub 当前文档为准。

输出与数据传递

矩阵与并发

复用与部署组合

目录与阅读设置

记录一个想法

GitHub Actions 工作流语法速查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通