Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[kots]: correctly escape params in installation configmap #10354

Merged
merged 1 commit into from
May 30, 2022

Conversation

mrsimonemms
Copy link
Contributor

@mrsimonemms mrsimonemms commented May 30, 2022

Description

Values in the gitpod-installation config map are incorrectly escaped. If a ' was introduced into the release notes, this would cause the YAML to become invalid.

The escaping of these values has been amended to be applied correctly, and added the use of the | quote pipe (which works identically to Helm).

Related Issue(s)

Fixes #10348

How to test

Run the command:

replicated release create \
  --lint \
  --ensure-channel \
  --yaml-dir ./install/kots \
  --promote ${REPLICATED_DEV_CHANNEL} \
  --release-notes "some release's \" note" \
  --version="$(date +%s)"

This will push a new release to your dev channel. This will allow you to run "check for updates" in the KOTS dashboard and then you'll see beautifully escaped YAML when you "view files"

image

Release Notes

[kots]: correctly escape params in installation configmap

Documentation

@mrsimonemms mrsimonemms marked this pull request as ready for review May 30, 2022 14:57
@mrsimonemms mrsimonemms requested a review from a team May 30, 2022 14:57
@github-actions github-actions bot added the team: delivery Issue belongs to the self-hosted team label May 30, 2022
Copy link
Contributor

@corneliusludmann corneliusludmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@roboquat roboquat merged commit 1792902 into main May 30, 2022
@roboquat roboquat deleted the sje/escape-installation branch May 30, 2022 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note size/S team: delivery Issue belongs to the self-hosted team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Escape values in KOTS installation file
3 participants