使用microsoft/variable-substitution替换嵌套JSON配置失败

问题原因 #

microsoft/variable-substitution@v1 会将环境变量值默认当作字符串处理，当传入嵌套JSON结构时，它会自动转义引号、换行符等特殊字符，导致最终appsettings.json中的externalapp变成带转义的字符串，而非预期的嵌套JSON对象。

解决方案 #

方法1：使用jq工具直接修改JSON（推荐） #

jq是专门处理JSON的命令行工具，能直接操作JSON结构，避免字符串转义问题。在GitHub工作流中添加以下步骤：

- name: Update externalapp with jq
  run: |
    # 将密钥中的JSON写入临时文件，避免直接解析的转义问题
    echo '${{ secrets.EXTERNAL_APP }}' > temp-extapp.json
    # 用jq替换appsettings.json中的externalapp字段
    jq --argjson extapp "$(cat temp-extapp.json)" '.externalapp = $extapp' appsettings.json > temp-settings.json
    # 覆盖原文件
    mv temp-settings.json appsettings.json

方法2：调整variable-substitution的参数处理 #

如果坚持使用microsoft/variable-substitution@v1，需要确保：

1. GitHub环境密钥EXTERNAL_APP存储的是紧凑单行JSON（无换行、无多余缩进，例如{"url":"https://example.com","clientid":"abc","secret":"xyz"}）
2. 使用fromJSON将密钥值解析为JSON对象后传入：

- name: Update Dynamics URL
  uses: microsoft/variable-substitution@v1 
  with:
    files: 'appsettings.json'
  env:
    externalapp: ${{ fromJSON(secrets.EXTERNAL_APP) }}

注意事项 #

• 存储GitHub环境密钥时，务必将嵌套JSON转为紧凑单行格式，否则fromJSON可能解析失败，或仍出现转义问题。
• jq方法兼容性更强，即使密钥中的JSON有换行或缩进，也能正确处理。

内容的提问来源于stack exchange，提问作者kamil hussain