search

helm / chart-releaser

Hosting Helm Charts via GitHub Pages and Releases
Apache License 2.0
662 stars 107 forks source link

Newlines in the chart description are not considered #125

Open marcofranssen opened 3 years ago

marcofranssen commented 3 years ago

In our helm chart we are using a description that contains new lines.

https://github.com/philips-labs/helm-charts/blob/spire-0.2.1/charts/spire/Chart.yaml#L3

These are not handled when creating the Github release, causing all this information to end up on the same line.

https://github.com/philips-labs/helm-charts/releases/tag/spire-0.2.1

⚠️ Please note: we have manually updated our release descriptions in Github to resolve it for now.

Could this be caused by https://github.com/helm/helm/blob/main/pkg/chart/loader/load.go#L84 which is called from the chart-releaser?

marcofranssen commented 3 years ago

Found the following:

https://github.com/ghodss/yaml/issues/56

This package is used in sigs.k8s.io/yaml.

sigs.k8s.io/yaml is used in https://github.com/helm/helm/blob/main/pkg/chart/loader/load.go#L84