GitHub Action - 在作业之间定义工作流级别的环境变量

Question

我希望在 Github Actions Workflow 中定义和设置作业之间的环境变量。 以下是我尝试过的工作流，但不幸的是环境变量 GIT_PR_SHA_SHORT 和 E2E_GIT_PR_SHA 无法工作。 这种情况可能吗？

name: Git Pull Request Workflow

on:
  workflow_dispatch:
  pull_request:
    branches:
      - master

env:
  GIT_PR_SHA: ${{github.event.pull_request.head.sha}}
  GIT_PR_SHA_SHORT: "${{ env.GIT_PR_SHA:0:10 }}"
  ENV_NAME: test
  E2E_GIT_PR_SHA: "${{ env.ENV_NAME }}-${{ env.GIT_PR_SHA_SHORT }}"

jobs:
  first-job:
    name: Build Docker Image
    runs-on: ubuntu-latest

    steps:
    - name: First Echo Step
      run: |
            echo "GIT_PR_SHA_SHORT = ${GIT_PR_SHA_SHORT}"
            echo "E2E_GIT_PR_SHA = ${E2E_GIT_PR_SHA}"

  second-job:
    name: Build Docker Image
    runs-on: ubuntu-latest

    steps:
    - name: Second Echo Step
      run: |
            echo "GIT_PR_SHA_SHORT = ${GIT_PR_SHA_SHORT}"
            echo "E2E_GIT_PR_SHA = ${E2E_GIT_PR_SHA}"

- James

Answer 1

您使用 ${{ env.VARIABLE_NAME }} 而不是 ${VARIABLE_NAME} 来引用工作流的环境变量。后者是bash语法，但这些不是shell环境变量，它们是工作流环境变量。它们是工作流执行的一部分，而不是shell上下文的一部分。

要引用工作流环境变量：

name: Git Pull Request Workflow

on:
  workflow_dispatch:
  pull_request:
    branches:
      - master

env:
  one: 1
  two: zwei
  three: tres

jobs:
  first-job:
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo "${{ env.one }}"
        echo "${{ env.two }}"
        echo "${{ env.three }}"

（我喜欢在我的工作流环境变量中使用小写，而在我的shell环境变量中使用大写，这样我就可以更清楚地区分它们。）

同样，这是行不通的：

env:
  GIT_PR_SHA_SHORT: "${{ env.GIT_PR_SHA:0:10 }}"

这里将bash语法:0:10与工作流语法混合使用，但工作流变量没有通过任何shell运行。在解析工作流文件时没有启动虚拟机，因此没有Shell可以运行。

如果您想使用bash表达式来操作环境，您需要创建一个步骤来运行bash，并且需要使用::set-env或::set-output语法。

然后，您可以使用${{ steps... }}上下文引用step的输出。

不幸的是，在不同的作业之间传递东西更加棘手，因为它们在不同的虚拟机上运行。您需要在整个工作流程本身上设置变量。您需要首先使用::set-output使其对作业可见，然后可以将其从作业提升到工作流程中。

name: Demonstration
on:
  push:
    branches: [master]

jobs:
  first-job:
    runs-on: ubuntu-latest  
    steps:
    - id: identify
      run: |
        # use bash variable expression to get the substring
        export GIT_PR_SHA="${{ github.sha }}"
        export GIT_PR_SHA_SHORT="${GIT_PR_SHA:0:10}"

        echo "::set-output name=git_pr_sha::${GIT_PR_SHA}"
        echo "::set-output name=git_pr_sha_short::${GIT_PR_SHA_SHORT}"
    outputs:
      git_pr_sha: ${{ steps.identify.outputs.git_pr_sha }}
      git_pr_sha_short: ${{ steps.identify.outputs.git_pr_sha_short }}

  second-job:
    needs: first-job
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo "${{ needs.first-job.outputs.git_pr_sha }}"
        echo "${{ needs.first-job.outputs.git_pr_sha_short }}"

- Edward Thomson

---

这段内容的第一部分并不完全正确。只要在bash/script执行范围内，我使用$WORKFLOW_VAR语法来处理那些顶层工作流环境变量是没有问题的。然而，在提供导入步骤参数或其他不在bash脚本中的情况下，我必须使用${{ env.VAR }}样式来提供值。 - GoForth

如果我要使用 set-output 作为变量共享的一种方式，那么如果第一个作业是支持矩阵的作业，我们该怎么办？ - Memphis Meng

set-output 和 set-state 将被移除。替代方案是 echo "key=value" >> $GITHUB_OUTPUT。更多信息请参见 https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/。 - Tuan Chau

Answer 2

我想补充一下这个内容，因为我也曾经遇到过类似的困难，不知道如何计算和设置环境变量以供多步使用。

以下是一个基本示例，展示了如何从步骤内部向github环境推回信息，如果需要计算后续使用的环境变量，则必须进行处理。您也可以通过同样的方式更新现有变量，而不仅仅是创建新变量。

name: minimal variable example

on:
  push:

env:
  MAJOR:                        "1"
  MINOR:                        "0"
  PATCH:                        "1"

jobs:
  vars-example:
    runs-on: ubuntu-latest

    steps:
      - name: only available local variable
        run: LOCAL_VERSION=${MAJOR}.${MINOR}.${PATCH}

      - name: available across multiple steps
        run: echo "GLOBAL_VERSION=${MAJOR}.${MINOR}.${PATCH}" >> $GITHUB_ENV

      - name: Vars
        run: |
          echo LOCAL_VERSION = $LOCAL_VERSION
          echo GLOBAL_VERSION = $GLOBAL_VERSION

这导致Vars输出为：

  echo LOCAL_VERSION = $LOCAL_VERSION
  echo GLOBAL_VERSION = $GLOBAL_VERSION
  shell: /usr/bin/bash -e {0}
  env:
    MAJOR: 1
    MINOR: 0
    PATCH: 1
    GLOBAL_VERSION: 1.0.1
LOCAL_VERSION =
GLOBAL_VERSION = 1.0.1

- dragonlipz

---

因为我刚刚又遇到了它。这是 Github 解释的链接。https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable - dragonlipz

Answer 3

以下是弃用后跨作业共享变量的更新方式

• 也涵盖了value本身是变量且需要在运行时计算的情况。
• 当进行master分支推送时，将调用以下内容

name: Sharing envs across jobs

on:
  push:
    branches: ['master']

env:
  one: onevalue
  two: twovalue
  three: threevalue

jobs:
  job0:
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo "${{ env.one }}"
          echo "${{ env.two }}"
          echo "${{ env.three }}"

  job1:
    runs-on: ubuntu-latest
    # Map a step output to a job output
    outputs:
      output1: ${{ steps.step1.outputs.test }}
      output2: ${{ steps.step2.outputs.test }}
    steps:
      - id: step1
        run: echo "test=$(date +"%d-%m-%Y")-asdfads223" >> $GITHUB_OUTPUT
      - id: step2
        run: echo "test=world" >> $GITHUB_OUTPUT
  job2:
    runs-on: ubuntu-latest
    needs: job1
    steps:
      - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}}

- codeaprendiz

Answer 4

在env元素下的表达式中不能使用env。我认为，除了使用表达式之外，没有其他方法，只能使用重复值。

env上下文语法允许您在工作流文件中使用环境变量的值。您可以在步骤的任何键的值中使用env上下文，但不能在id和uses键中使用。有关步骤语法的更多信息，请参见"GitHub Actions的工作流语法"。

https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#env-context

- riQQ

---

抱歉如果我表达不够清晰，让我重新阐述我的问题。 我如何设置环境变量GIT_PR_SHA_SHORT（GIT SHA的前10个数字）和E2E_GIT_PR_SHA（前一个环境变量ENV_NAME和GIT_PR_SHA_SHORT的连接），并使它们在github action工作流运行的每个步骤和作业中都可用。我不想为工作流中的每个步骤和作业重复相同的（::set-env）代码。 - James