helm / helm/chart-releaser

Newlines in the chart description are not considered

Open
#125 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
783
Forks
126
Avg merge
1d 18h
Merged PRs (30d)
11

Description

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?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing how chart-releaser builds the GitHub release description and compare that flow with Helm's pkg/chart/loader/load.go, which the issue identifies as a possible source. Use the linked Chart.yaml and release as reproduction references; done means newline characters in chart descriptions remain separate lines in generated GitHub releases.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, helm
Domain
devops, release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.