Github api 不解析多行 shell 变量

Question

我在 jenkins 配置中有一个文本参数（来自 jenkins job dsl 插件），它允许您输入多行注释。从 shell 脚本向 github 存储库发布版本时，我使用该变量作为主体值。我收到这个错误，说解析 json 有问题，我找不到解决方法。我会在下面给你举个例子。请帮忙。

PERSONAL_ACCESS_TOKEN="random"
TAG_NAME="12.0.0"
VERSION_BUMP="major"
MIGRATION_DOCUMENT="This is first line
This is second line"

curl -i \
-H "Authorization: token ${PERSONAL_ACCESS_TOKEN}" \
-d '{"tag_name": "'"${TAG_NAME}"'", "name": "'"${VERSION_BUMP}"'", \
"body": "'"${MIGRATION_DOCUMENT}"'"}' \
https://github.deere.com/api/v3/repos/randomOrg/testRepo/releases

Answer 1

这个

{ "a": "b
c" }

是无效的 JSON，因为字符串不能包含控制字符，例如换行符。

如果您有一个包含换行符的字符串，您可以将它们转换为\n使用 shell 参数扩展：

$ var='a
b'
$ echo "$var"
a
b
$ echo "${var//$'\n'/'\n'}"
a\nb

因此，要将字符串输入 JSON 对象，请使用

"body": "'"${MIGRATION_DOCUMENT//$'\n'/'\n'}"'"

在 JSON 对象的末尾。

此外，如果您在单引号中使用换行符，例如

var='abc \
def'

然后反斜杠和换行符是文字：

$ echo "$var"
abc \
def

不要在单引号字符串中使用这样的行继续符。

总而言之：

curl -i \
    -H "Authorization: token ${PERSONAL_ACCESS_TOKEN}" \
    -d '{"tag_name": "'"${TAG_NAME}"'", "name": "'"${VERSION_BUMP}"'", "body": "'"${MIGRATION_DOCUMENT//$'\n'/'\n'}"'"}' \
    https://github.deere.com/api/v3/repos/randomOrg/testRepo/releases

如果你真的想，你仍然可以使用行延续，但它必须在双引号上下文中：

curl -i \
    -H "Authorization: token ${PERSONAL_ACCESS_TOKEN}" \
    -d '{"tag_name": "'"${TAG_NAME}"'", "name": "'"${VERSION_BUMP}"'", '"\
        "'"body": "'"${MIGRATION_DOCUMENT//$'\n'/'\n'}"'"}' \
    https://github.deere.com/api/v3/repos/randomOrg/testRepo/releases

作为旁注，您不应该对变量使用所有大写名称；这些是为环境变量保留的，请参阅POSIX 规范（第四段）。