GitHub Actions 的上下文和表达式语法

您可以访问上下文信息并对工作流程和操作中的表达式求值。

GitHub Actions 可用于 GitHub Free、GitHub Pro、组织的 GitHub Free、GitHub Team、GitHub Enterprise Cloud 和 GitHub AE。 GitHub Actions 不适用于使用旧版按仓库计划的帐户所拥有的私有仓库。

本文内容

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

关于上下文和表达式

您可以使用表达式程序化设置工作流程文件中的变量和访问上下文。 表达式可以是文字值、上下文引用或函数的任意组合。 您可以使用运算符组合文字、上下文引用和函数。

表达式通常在工作流程文件中与条件性 if 关键词一起用来确定步骤是否应该运行。 当 if 条件为 true 时,步骤将会运行。

您需要使用特定语法指示 GitHub 对表达式求值,而不是将其视为字符串。

${{ <expression> }}

if 条件下使用表达式时,可以省略表达式语法 (${{ }}),因为 GitHub 会自动将 if 条件作为表达式求值,除非表达式包含任何运算符。 如果表达式包含任何运算符,则表达式必须包含在 ${{ }} 内,以明确标记它进行计算。有关 if 条件的更多信息,请参阅“GitHub Actions 的工作流程语法”。

警告:创建工作流程和操作时,您应始终考虑您的代码是否会执行来自可能的攻击者的不信任输入。 某些上下文应被视为不受信任的输入,因为攻击者可能会插入自己的恶意内容。 更多信息请参阅“了解脚本注入的风险”。

if 条件的示例表达式
steps:
  - uses: actions/hello-world-javascript-action@v1.1
    if: ${{ <expression> }}
设置环境变量的示例
env:
  MY_ENV_VAR: ${{ <expression> }}

上下文

上下文是一种访问工作流程运行、运行器环境、作业及步骤相关信息的方式。 上下文使用表达式语法。

${{ <context> }}

上下文名称类型描述
github对象工作流程运行的相关信息。 更多信息请参阅 github 上下文
env对象包含工作流程、作业或步骤中设置的环境变量。 更多信息请参阅 env 上下文
作业对象当前执行的作业相关信息。 更多信息请参阅 job 上下文
steps对象此作业中已经运行的步骤的相关信息。 更多信息请参阅 steps 上下文
runner对象运行当前作业的运行程序相关信息。 更多信息请参阅 runner 上下文
secrets对象启用对密码的访问权限。 有关密码的更多信息,请参阅“创建和使用加密密码”。
strategy对象用于访问配置的策略参数及当前作业的相关信息。 策略参数包括 fail-fastjob-indexjob-totalmax-parallel
matrix对象用于访问为当前作业配置的矩阵参数。 例如,如果使用 osnode 版本配置矩阵构建,matrix 上下文对象将包含当前作业的 osnode 版本。
needs对象允许访问定义为当前作业依赖项的所有作业的输出。 更多信息请参阅 needs 上下文

作为表达式的一部分,您可以使用以下两种语法之一访问上下文信息。

  • 索引语法:github['sha']
  • 属性解除参考语法:github.sha

要使用属性解除参考语法,属性名称必须:

  • a-Z_ 开头。
  • 后跟 a-Z 0-9 -_

确定何时使用上下文

GitHub Actions 包含一个称为上下文的变量集和一个称为默认环境变量的类似变量集。 这些变量预期用于工作流程中的不同点:

  • 默认环境变量:这些变量仅存在于执行作业的运行器上。 更多信息请参阅“默认环境变量”。
  • 上下文:您可以在工作流程的任何时候使用大多数上下文,包括当默认环境变量不可用时。 例如,您可以使用带表达式的上下文执行初始处理,然后将作业路由到运行器以供执行;这允许您使用带有条件 if 关键字的上下文来确定步骤是否应运行。 作业运行后,您还可以从执行作业的运行器(如 runner.os)检索上下文变量。 更多信息请参阅“上下文”。

下面的示例演示了这些不同类型的环境变量如何在一个作业中一起使用:

name: CI
on: push
jobs:
  prod-check:
    if: ${{ github.ref == 'refs/heads/main' }}
    runs-on: ubuntu-latest
    steps:
      - run: echo "Deploying to production server on branch $GITHUB_REF"

在此示例中,if 语句检查 github.ref 上下文以确定当前分支名称;如果名称是 refs/heads/main,则执行后续步骤。 if 检查由 GitHub Actions 处理,作业仅在结果为 true 时才发送到运行器。 作业发送到运行器后, 该步骤将执行并引用运行器的 $GITHUB_REF 环境变量。

github 上下文

github 上下文包含有关工作流程运行以及触发运行的事件相关信息。 您可以读取环境变量中的大多数 github 上下文数据。 有关环境变量的更多信息,请参阅“使用环境变量”。

警告:在使用整个 github 上下文时,请注意其中包括诸如 github.token 等敏感信息。 GitHub 在打印到控制台时会隐藏密钥,但您在导出或打印上下文时应谨慎行事。

警告:创建工作流程和操作时,您应始终考虑您的代码是否会执行来自可能的攻击者的不信任输入。 某些上下文应被视为不受信任的输入,因为攻击者可能会插入自己的恶意内容。 更多信息请参阅“了解脚本注入的风险”。

属性名称类型描述
github对象工作流程中任何作业或步骤期间可用的顶层上下文。
github.action字符串正在运行的操作的名称。 在当前步骤运行脚本时,GitHub 删除特殊字符或使用名称 run。 如果在同一作业中多次使用相同的操作,则名称将包括带有序列号的后缀。 例如,运行的第一个脚本名称为 run1,则第二个脚本将命名为 run2。 同样,actions/checkout 第二次调用时将变成 actionscheckout2
github.action_path字符串您的操作所在的路径。 您可以使用此路径轻松访问与操作位于同一仓库中的文件。 此属性仅在复合运行步骤操作中才受支持。
github.actor字符串发起工作流程运行的用户的登录名。
github.base_ref字符串工作流程运行中拉取请求的 base_ref 或目标分支。 此属性仅在触发工作流程运行的事件为 pull_requestpull_request_target 时才可用。
github.event对象完整事件 web 挂钩有效负载。 更多信息请参阅“触发工作流程的事件”。 您可以使用上下文访问事件的个别属性。
github.event_name字符串触发工作流程运行的事件的名称。
github.event_path字符串运行器上完整事件 web 挂钩有效负载的路径。
github.head_ref字符串工作流程运行中拉取请求的 head_ref 或来源分支。 此属性仅在触发工作流程运行的事件为 pull_requestpull_request_target 时才可用。
github.job字符串当前作业的 job_id
github.ref字符串触发工作流程的分支或标记参考。 对于分支,使用格式 refs/heads/<branch_name>,对于标记是 refs/tags/<tag_name>
github.repository字符串所有者和仓库名称。 例如 Codertocat/Hello-World
github.repository_owner字符串仓库所有者的名称。 例如 Codertocat
github.run_id字符串仓库中每个运行的唯一编号。 如果您重新执行工作流程运行,此编号不变。
github.run_number字符串仓库中特定工作流程每个运行的唯一编号。 此编号从 1(对应于工作流程的第一个运行)开始,然后随着每个新的运行而递增。 如果您重新执行工作流程运行,此编号不变。
github.sha字符串触发工作流程的提交 SHA。
github.token字符串代表仓库上安装的 GitHub 应用程序进行身份验证的令牌。 这在功能上等同于 GITHUB_TOKEN 密码。 更多信息请参阅“使用 GITHUB_TOKEN 验证身份”。
github.workflow字符串工作流程的名称。 如果工作流程文件未指定 name,此属性的值将是仓库中工作流程文件的完整路径。
github.workspace字符串使用 checkout 操作时步骤的默认工作目录和仓库的默认位置。

env 上下文

env 上下文包含已在工作流程、作业或步骤中设置的环境变量。 有关在工作流程中设置环境变量的更多信息,请参阅“GitHub Actions 的工作流程语法”。

env 上下文语法允许您在工作流程文件中使用环境变量的值。 您可以在步骤的任何键值中使用 env 上下文,但 iduses 键除外。 有关步骤语法的更多信息,请参阅“GitHub Actions 的工作流程语法”。

如果您想要在运行器中使用环境变量的值,请使用运行器操作系统的正常方法来读取环境变量。

属性名称类型描述
env对象此上下文针对作业中的每个步骤而改变。 您可以从作业中的任何步骤访问此上下文。
env.<env_name>字符串特定环境变量的值。

job 上下文

job 上下文包含当前正在运行的作业相关信息。

属性名称类型描述
job对象此上下文针对工作流程运行中的每项作业而改变。 您可以从作业中的任何步骤访问此上下文。
job.container对象作业的容器相关信息。 有关容器的更多信息,请参阅“GitHub Actions 的工作流程语法”。
job.container.id字符串容器的 id。
job.container.network字符串容器网络的 id。 运行程序创建作业中所有容器使用的网络。
job.services对象为作业创建的服务容器。 有关服务容器的更多信息,请参阅“GitHub Actions 的工作流程语法”。
job.services.<service id>.id字符串服务容器的 id。
job.services.<service id>.network字符串服务容器网络的 id。 运行程序创建作业中所有容器使用的网络。
job.services.<service id>.ports对象服务容器显露的端口。
job.status字符串作业的当前状态。 可能的值包括 successfailurecancelled

steps 上下文

steps 上下文包含当前作业中已经运行的步骤相关信息。

属性名称类型描述
steps对象此上下文针对作业中的每个步骤而改变。 您可以从作业中的任何步骤访问此上下文。
steps.<step id>.outputs对象为步骤定义的输出集。 更多信息请参阅“GitHub Actions 的元数据语法”。
steps.<step id>.conclusion字符串continue-on-error 应用之后完成的步骤的结果。 可能的值包括 successfailurecancelledskipped。 当 continue-on-error 步骤失败时,outcomefailure,但最终的 conclusionsuccess
steps.<step id>.outcome字符串continue-on-error 应用之前完成的步骤的结果。 可能的值包括 successfailurecancelledskipped。 当 continue-on-error 步骤失败时,outcomefailure,但最终的 conclusionsuccess
steps.<step id>.outputs.<output name>字符串特定输出的值。

runner 上下文

runner 上下文包含正在执行当前作业的运行器相关信息。

属性名称类型描述
runner.os字符串执行作业的运行器的操作系统。 可能的值为 LinuxWindowsmacOS
runner.temp字符串运行器临时目录的路径。 此目录保证在每个作业开始时为空,即使在自托管的运行器上也是如此。
runner.tool_cache字符串包含 GitHub 托管运行器一些预安装工具的目录路径。 更多信息请参阅“GitHub 托管运行器的规范”。

needs 上下文

needs 上下文包含定义为当前作业依赖项的所有作业的输出。 有关定义作业依赖项的更多信息,请参阅“GitHub Actions 的工作流程语法”。

属性名称类型描述
needs.<job id>对象当前作业依赖的单个作业。
needs.<job id>.outputs对象当前作业依赖的作业的输出集。
needs.<job id>.outputs.<output name>字符串当前作业依赖的作业的特定输出值。
needs.<job id>.result字符串当前作业依赖的作业的结果。 可能的值包括 successfailurecancelledskipped
打印上下文信息到日志文件的示例

要检查每个上下文中可访问的信息,您可以使用此工作流程文件示例。

警告:在使用整个 github 上下文时,请注意其中包括诸如 github.token 等敏感信息。 GitHub 在打印到控制台时会隐藏密钥,但您在导出或打印上下文时应谨慎行事。

.github/workflows/main.yml

on: push

jobs:
  one:
    runs-on: ubuntu-latest
    steps:
      - name: Dump GitHub context
        env:
          GITHUB_CONTEXT: ${{ toJSON(github) }}
        run: echo "$GITHUB_CONTEXT"
      - name: Dump job context
        env:
          JOB_CONTEXT: ${{ toJSON(job) }}
        run: echo "$JOB_CONTEXT"
      - name: Dump steps context
        env:
          STEPS_CONTEXT: ${{ toJSON(steps) }}
        run: echo "$STEPS_CONTEXT"
      - name: Dump runner context
        env:
          RUNNER_CONTEXT: ${{ toJSON(runner) }}
        run: echo "$RUNNER_CONTEXT"
      - name: Dump strategy context
        env:
          STRATEGY_CONTEXT: ${{ toJSON(strategy) }}
        run: echo "$STRATEGY_CONTEXT"
      - name: Dump matrix context
        env:
          MATRIX_CONTEXT: ${{ toJSON(matrix) }}
        run: echo "$MATRIX_CONTEXT"

文字

作为表达式的一部分,您可以使用 booleannullnumberstring 数据类型。 Boolean 文字不区分大小写,因此可以使用 trueTrue

数据类型文字值
布尔值truefalse
nullnull
numberJSON 支持的任何数字格式。
字符串必须使用单引号。 使用单引号逸出文字单引号。
示例
env:
  myNull: ${{ null }}
  myBoolean: ${{ false }}
  myIntegerNumber: ${{ 711 }}
  myFloatNumber: ${{ -9.2 }}
  myHexNumber: ${{ 0xff }}
  myExponentialNumber: ${{ -2.99-e2 }}
  myString: ${{ 'Mona the Octocat' }}
  myEscapedString: ${{ 'It''s open source!' }}

运算符

运算符描述
( )逻辑分组
[ ]索引
.属性解除参考
!
<小于
<=小于或等于
>大于
>=大于或等于
==等于
!=不等于
&&
||

GitHub 进行宽松的等式比较。

  • 如果类型不匹配,GitHub 强制转换类型为数字。 GitHub 使用这些转换将数据类型转换为数字:

    类型结果
    Null0
    布尔值true 返回 1
    false 返回 0
    字符串从任何合法 JSON 数字格式剖析,否则为 NaN
    注:空字符串返回 0
    数组NaN
    对象NaN
  • 一个 NaN 与另一个 NaN 的比较不会产生 true。 更多信息请参阅“NaN Mozilla 文档”。

  • GitHub 在比较字符串时忽略大小写。

  • 对象和数组仅在为同一实例时才视为相等。

函数

GitHub 提供一组内置的函数,可用于表达式。 有些函数抛出值到字符串以进行比较。 GitHub 使用这些转换将数据类型转换为字符串:

类型结果
Null''
布尔值'true''false'
数字十进制格式,对大数字使用指数
数组数组不转换为字符串
对象对象不转换为字符串

contains

contains( search, item )

如果 search 包含 item,则返回 true。 如果 search 为数组,此函数在 item 为数组中的元素时返回 true。 如果 search 为字符串,此函数在 itemsearch 的子字符串时返回 true。 此函数不区分大小写。 抛出值到字符串。

使用数组的示例

contains(github.event.issue.labels.*.name, 'bug')

使用字符串的示例

contains('Hello world', 'llo') 返回 true

startsWith

startsWith( searchString, searchValue )

searchStringsearchValue 开头时返回 true。 此函数不区分大小写。 抛出值到字符串。

示例

startsWith('Hello world', 'He') 返回 true

endsWith

endsWith( searchString, searchValue )

searchStringsearchValue 结尾时返回 true。 此函数不区分大小写。 抛出值到字符串。

示例

endsWith('Hello world', 'ld') 返回 true

format

format( string, replaceValue0, replaceValue1, ..., replaceValueN)

string 中的值替换为变量 replaceValueNstring 中的变量使用 {N} 语法指定,其中 N 为整数。 必须指定至少一个 replaceValuestring。 可以使用变量 (replaceValueN) 数没有上限。 使用双小括号逸出大括号。

示例

返回 'Hello Mona the Octocat'

format('Hello {0} {1} {2}', 'Mona', 'the', 'Octocat')

逸出括号示例

返回 '{Hello Mona the Octocat!}'

format('{{Hello {0} {1} {2}!}}', 'Mona', 'the', 'Octocat')

join

join( array, optionalSeparator )

array 的值可以是数组或字符串。 array 中的所有值强制转换为字符串。 如果您提供 optionalSeparator,它将被插入到串联的值之间。 否则使用默认分隔符 ,。 抛出值到字符串。

示例

join(github.event.issue.labels.*.name, ', ') 可能返回 'bug, help wanted'

toJSON

toJSON(value)

value 返回适合打印的 JSON 表示形式。 您可以使用此函数调试上下文中提供的信息。

示例

toJSON(job) 可能返回 { "status": "Success" }

fromJSON

fromJSON(value)

返回 value 的 JSON 对象或 JSON 数据类型。 您可以使用此函数来提供 JSON 对象作为评估表达式或从字符串转换环境变量。

返回 JSON 对象的示例

此工作流程在一个作业中设置 JSON矩阵,并使用输出和 fromJSON 将其传递到下一个作业。

name: build
on: push
jobs:
  job1:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - id: set-matrix
        run: echo "::set-output name=matrix::{\"include\":[{\"project\":\"foo\",\"config\":\"Debug\"},{\"project\":\"bar\",\"config\":\"Release\"}]}"
  job2:
    needs: job1
    runs-on: ubuntu-latest
    strategy:
      matrix: ${{fromJSON(needs.job1.outputs.matrix)}}
    steps:
      - run: build
返回 JSON 数据类型的示例

此工作流程使用 fromJSON 将环境变量从字符串转换为布尔值或整数。

name: print
on: push
env: 
  continue: true
  time: 3
jobs:
  job1:
    runs-on: ubuntu-latest
    steps:
      - continue-on-error: ${{ fromJSON(env.continue) }}
        timeout-minutes: ${{ fromJSON(env.time) }}
        run: echo ...

hashFiles

hashFiles(path)

返回匹配 path 模式的文件集的单个哈希值。 您可以提供单一 path 模式,或以逗号分隔的多个 path 模式。 path 相对于 GITHUB_WORKSPACE 目录,只能包括 GITHUB_WORKSPACE 中的文件。 此函数为每个匹配的文件计算单独的 SHA-256 哈希, 然后使用这些哈希来计算文件集的最终 SHA-256 哈希。 有关 SHA-256 的更多信息,请参阅“SHA-2”。

您可以使用模式匹配字符来匹配文件名。 模式匹配在 Windows 上不区分大小写。 有关支持的模式匹配字符的更多信息,请参阅“GitHub Actions 的工作流程语法”。

单一模式示例

匹配仓库中的任何 package-lock.json 文件。

hashFiles('**/package-lock.json')

多个模式示例

为仓库中的任何 package-lock.jsonGemfile.lock 文件创建哈希。

hashFiles('**/package-lock.json', '**/Gemfile.lock')

作业状态检查函数

您可以使用以下状态检查函数作为 if 条件中的表达式。 如果 if 表达式不含任何状态函数,将自动返回 success() 结果。 有关 if 条件的更多信息,请参阅“GitHub 操作的工作流程语法”。

success

当前面的步骤没有失败或取消时返回 true

示例
steps:
  ...
  - name: The job has succeeded
    if: ${{ success() }}

always

始终返回 true,即使已取消也一样。 作业或步骤在重大故障阻止任务运行时不会运行。 例如,如果获取来源失败。

示例
if: ${{ always() }}

cancelled

在工作流程取消时返回 true

示例
if: ${{ cancelled() }}

failure

在作业的任何之前一步失败时返回 true

示例
steps:
  ...
  - name: The job has failed
    if: ${{ failure() }}

对象过滤器

可以使用 * 语法应用过滤条件并从集合中选择匹配的项目。

例如,考虑名为 fruits 的对象数组。

[
  { "name": "apple", "quantity": 1 },
  { "name": "orange", "quantity": 2 },
  { "name": "pear", "quantity": 1 }
]

过滤条件 fruits.*.name 返回数组 [ "apple", "orange", "pear" ]

此文档对您有帮助吗?隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。