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

时间:2020-08-18 11:27:54

标签: github-actions

我想在我的Github Actions工作流程内的工作之间定义和设置环境变量。 下面的工作流程是我尝试过的工作,但是很遗憾,环境变量 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}"

3 个答案:

答案 0 :(得分:5)

您使用${{ env.VARIABLE_NAME }}而不是${VARIABLE_NAME}引用工作流程的环境变量。后者是bash语法,但不是shell环境变量,它们是 workflow 环境变量。它们是工作流执行的一部分,而不是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 }}"

(我喜欢在工作流程环境变量中使用lower-case,而在shell环境变量中使用UPPER_CASE,所以对我来说哪个是更明显。)

类似地,这将不起作用:

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

这是将bash语法:0:10与工作流语法混合在一起,但是工作流变量没有通过任何shell运行。解析工作流文件时,没有启动任何虚拟机,因此没有外壳可以运行任何东西。

如果要使用bash表达式来操纵环境,则需要创建一个运行bash的步骤来执行此操作,并且需要使用::set-env::set-output语法。 / p>

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

不幸的是,在不同作业之间传递消息比较棘手,因为它们在不同的虚拟机上运行。您需要在整个工作流程本身上设置变量。您首先需要::set-output,以便对 job 可见,然后可以提高从工作到工作流程的可见性。

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 }}"

答案 1 :(得分:1)

我想为此添加一个扩展,因为我在寻找如何计算和设置多步使用的环境变量时遇到了类似的困难。

下面是一个基本示例,说明如果需要处理以计算环境变量以供以后使用,如何从一个步骤内推回 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

答案 2 :(得分:0)

您不能在env元素下的表达式中使用env。除了使用重复值而不是表达式,我看不到其他方法。

您只能在envwith键的值中使用name上下文,或者在条件的情况下在步骤中使用。有关步骤语法的更多信息,请参见"Workflow syntax for GitHub Actions"

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