GitHub ENV中引号与&符号并存时的转义问题及方案咨询

问题原因 #

1. Shell语法解析冲突：GitHub Actions在执行shell步骤前会先完成变量插值。当环境变量同时包含双引号和&时，插值后的命令会破坏shell的语法结构。例如变量内容为"abc&def"，插值后命令变为echo ""abc&def""——shell会将第一个"视为闭合，随后的&被解析为后台执行符号，剩余内容被当作新命令执行，最终导致输出截断或报错。单独存在引号或&时，shell的引号包裹逻辑能正常处理，因此无异常。
2. CAT EOF的局限性：Here-doc（cat <<EOF）方式会将内容当作纯文本处理，不解析特殊字符，因此能正常输出变量内容，但这种方式仅在当前shell步骤有效，无法将处理后的变量传递到非shell步骤（如PR评论动作），因为非shell步骤直接读取GITHUB_ENV中存储的原始未处理变量。

可行解决方案 #

方案1：使用toJSON函数转义变量 #

GitHub Actions内置的toJSON函数会自动转义变量中的所有特殊字符（包括引号、&等），生成符合JSON规范的字符串，既能让shell正确解析，也能直接在非shell步骤中使用。
示例配置：

jobs:
  test-env:
    runs-on: ubuntu-latest
    steps:
      - name: 设置含特殊字符的环境变量
        run: |
          echo 'SOME_ENV_VAR="test&special"' >> "$GITHUB_ENV"
      - name: 在shell步骤中输出变量
        run: echo ${{ toJSON(env.SOME_ENV_VAR) }}
      - name: 在PR评论动作中使用变量
        uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: ${{ toJSON(env.SOME_ENV_VAR) }}
            })

说明：toJSON会将"test&special"转换为"\"test&special\""，shell执行时会正确识别为完整字符串，非shell步骤（如github-script）可直接解析该JSON字符串作为内容。

方案2：Base64编码存储与解码 #

对变量内容进行Base64编码后存入环境变量，使用时再解码。编码后的内容仅包含字母、数字和特殊符号+/=，不会触发shell或Actions的语法解析问题，适用于内容极复杂的场景。
示例配置：

jobs:
  test-env:
    runs-on: ubuntu-latest
    steps:
      - name: 编码并设置环境变量
        run: |
          RAW_CONTENT='"test&quote&more"'
          ENCODED_CONTENT=$(echo "$RAW_CONTENT" | base64 -w 0)
          echo "SOME_ENV_VAR=$ENCODED_CONTENT" >> "$GITHUB_ENV"
      - name: 在shell步骤解码输出
        run: |
          echo "$(echo "${{ env.SOME_ENV_VAR }}" | base64 -d)"
      - name: 在PR评论动作中解码使用
        uses: actions/github-script@v6
        with:
          script: |
            const rawContent = Buffer.from(process.env.SOME_ENV_VAR, 'base64').toString();
            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: rawContent
            })

方案3：单引号包裹插值变量（限无单引号的内容） #

如果变量内容仅包含双引号和&，无单引号，可在shell步骤中用单引号包裹插值后的变量。shell会将单引号内的内容视为纯文本，不解析任何特殊字符。
示例配置：

jobs:
  test-env:
    runs-on: ubuntu-latest
    steps:
      - name: 设置环境变量
        run: |
          echo 'SOME_ENV_VAR="test&quote"' >> "$GITHUB_ENV"
      - name: 单引号包裹输出
        run: echo '${{ env.SOME_ENV_VAR }}'

注意：若变量内容包含单引号，需先将单引号转义为'\''，否则会导致shell语法错误。

内容的提问来源于stack exchange，提问作者kent-id