version description in helm_release doesn't correctly describe actual behavior per notes in #102

[oshaughnessy]

In the helm_release docs, version is described this way:

version - (Optional) Specify the exact chart version to install. If this is not specified, the latest version is installed.

But the latest version isn't actually installed. From a comment in issue 102:

This is the expected behaviour - we want to encourage the practice of being explicit about the upgrade version when upgrading an installed chart. We'll take a note to improve the documentation referenced above.

I found the actual behavior by googling and discovering that issue report, so I'm following up here to note that the docs still haven't been updated to describe it that way.

I think if the intention is that people include a version spec to force an update, you may as well make it a required option. Leaving it optional just causes confusion. Per the comment in the referenced issue, you're not really "encouraging" people, you're forcing them, but the docs don't make that clear. Sure, it will work at initial deployment without specifying a version, but as soon as a change is needed, a version must be specified or, per #121, the helm_release resource won't actually trigger a change.

Personally, though, I'd suggest it would be a much nicer behavior to leave it optional and let people choose whether they want to be explicit about it, and modify the behavior so that the latest really is installed when needed.

I think chances are high that if someone is changing their chart's version number, they expect the terraform that references it to figure out that it has changed and bump it up. That's the described default behavior now. At least in my scenario, where I have the terraform and the chart in the same folder of a repo, I have to keep 2 version strings in sync across nearly-adjacent files, and it's an error-prone update workflow. I'd much rather change it in once place and let the code be smart. DRY, right? I think your current and intended behavior makes sense when the chart is hosted elsewhere, but I don't like it when it's local. :-)

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.