docs: clarify that HelmChart version field is only for chart repository #6368
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change clarifies that the version field is only applicable when using a Helm chart repository, similar to how ref field has a note about gitRemote. Fixes: pipe-cd#6366 Signed-off-by: tani-yu <e085734@ie.u-ryukyu.ac.jp>
Member
|
Please also update this v0.55.x docs (same change in docs-dev) |
Signed-off-by: tani-yu <e085734@ie.u-ryukyu.ac.jp>
Contributor
Author
|
Done, updated v0.55.x as well. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does:
Adds clarification to the
versionfield description in HelmChart configuration reference, noting that it is only valid when using a chart repository.Why we need it:
Currently, the
reffield has a note saying "Only valid when gitRemote is not empty", but theversionfield lacks a similar clarification. This can confuse users about which field to use for specifying chart versions in different scenarios (git remote vs chart repository).Which issue(s) this PR fixes:
Fixes #6366
Does this PR introduce a user-facing change?:
Note
I only updated docs-dev. Let me know if other versioned docs (e.g., docs-v0.55.x) should also be updated.