Safe templating of json in bash scripts

[justaugustus]

There are a few places in our scripts where we template JSON directly in bash e.g.,

release/anago

Lines 1131 to 1138 in c32c094

	'{
	"tag_name": "'$RELEASE_VERSION_PRIME'",
	"target_commitish": "'$RELEASE_BRANCH'",
	"name": "'$RELEASE_VERSION_PRIME'",
	"body": "See [kubernetes-announce@](https://groups.google.com/forum/#!forum/kubernetes-announce) and ['$CHANGELOG_FILE']('$changelog_url'#'${RELEASE_VERSION_PRIME//\./}') for details.\n\nSHA512 for `kubernetes.tar.gz`: `'$sha_hash'`\n\nAdditional binary downloads are linked in the ['$CHANGELOG_FILE']('$changelog_url'#downloads-for-'${RELEASE_VERSION_PRIME//\./}').",
	"draft": '$draft',
	"prerelease": '$prerelease'
	}' |jq -r '.id')

As @hoegaarden mentions, it'd be nicer/less scary to handle this in a safer way via jq, like this:

release/lib/gitlib.sh

Lines 341 to 352 in c32c094

	template='{
	"title": $title,
	"body": $body,
	"milestone": $milestone,
	}'
	data="$( jq \
	--argjson milestone "$milestone" \
	--arg body "$body" \
	--arg title "$title" \
	-c -n "$template"
	)"

This is another good one for a Release Manager Associate to take up.

/help
cc: @kubernetes/release-engineering
/area release-eng
/priority important-longterm
/kind cleanup

[k8s-ci-robot]

@justaugustus:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

There are a few places in our scripts where we template JSON directly in bash e.g.,

release/anago

Lines 1131 to 1138 in c32c094

	'{
	"tag_name": "'$RELEASE_VERSION_PRIME'",
	"target_commitish": "'$RELEASE_BRANCH'",
	"name": "'$RELEASE_VERSION_PRIME'",
	"body": "See [kubernetes-announce@](https://groups.google.com/forum/#!forum/kubernetes-announce) and ['$CHANGELOG_FILE']('$changelog_url'#'${RELEASE_VERSION_PRIME//\./}') for details.\n\nSHA512 for `kubernetes.tar.gz`: `'$sha_hash'`\n\nAdditional binary downloads are linked in the ['$CHANGELOG_FILE']('$changelog_url'#downloads-for-'${RELEASE_VERSION_PRIME//\./}').",
	"draft": '$draft',
	"prerelease": '$prerelease'
	}' |jq -r '.id')

As @hoegaarden mentions, it'd be nicer/less scary to handle this in a safer way via jq, like this:

release/lib/gitlib.sh

Lines 341 to 352 in c32c094

	template='{
	"title": $title,
	"body": $body,
	"milestone": $milestone,
	}'
	data="$( jq \
	--argjson milestone "$milestone" \
	--arg body "$body" \
	--arg title "$title" \
	-c -n "$template"
	)"

This is another good one for a Release Manager Associate to take up.

/help
cc: @kubernetes/release-engineering
/area release-eng
/priority important-longterm
/kind cleanup

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[hasheddan]

@justaugustus I am happy to take this one!

/assign @hasheddan