[BUG] generate_helm.sh doesn't update helm docs for all charts

[lowc1012]

Describe the bug

When I updated values.yaml in flyte-binary chart and ran make helm, the README.md didn't be modified

Expected behavior

README.md should be modified if I modified the values.yaml in charts. Need to check if each helm doc can be modified with changed vaules.yaml via generate_helm.sh.

Additional context to reproduce

No response

Screenshots

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[dosubot]

🤖

Hey there @lowc1012! Great to see you around here again. 😄 I'll dive into this helm docs conundrum and get back to you with a full answer shortly. Hang tight!

[lowc1012]

#take

[dosubot]

🤖

Based on the information you've provided, it seems like you've already run the generate_helm.sh script after making changes to the values.yaml file in the flyte-binary chart, but the README.md was not updated as expected.

The generate_helm.sh script should indeed update the helm docs for all charts, including the flyte-binary chart, when changes are made to the values.yaml file. The script checks if helm-docs is installed, installs it if it's not, and then runs helm-docs on the charts directory. The helm-docs command generates documentation for helm charts based on the values.yaml file and other files in the chart directory. So, any changes made to the values.yaml file should be reflected in the generated documentation when this script is run.

If the README.md for the flyte-binary chart was not updated as expected, it could be due to a few reasons:

1. There might be an issue with the helm-docs tool itself. You can try updating it to the latest version and see if that resolves the issue.
2. There might be an issue with the values.yaml file. Make sure it's formatted correctly and doesn't contain any errors.
3. There might be an issue with the generate_helm.sh script. You can try running the helm-docs command manually on the flyte-binary chart directory and see if that updates the README.md.

If none of these suggestions resolve the issue, it would be helpful if you could provide more information about the changes you made to the values.yaml file and the exact steps you took when running the generate_helm.sh script. This will help in identifying the cause of the issue.

For reference, here is the section of the generate_helm.sh script that generates the helm docs:

echo "Generating helm docs"
if  command -v helm-docs &> /dev/null
then
    rm $(which helm-docs)
fi

GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest

${GOPATH:-~/go}/bin/helm-docs -c ${DIR}/../charts/

And here is the structure of the flyte-binary chart in the Flyte repository:

• apiVersion: v2
• name: flyte-binary
• description: Chart for basic single Flyte executable deployment
• type: application
• version: v0.1.10
• appVersion: 1.16.0
• dependencies:
  • name: flyteagent
  • condition: flyteagent.enabled
  • alias: flyteagent
  • version: v0.1.10
  • repository: file://../flyteagent

Sources:

• script/generate_helm.sh
• charts/flyte-binary/Chart.yaml

Sources

• script/generate_helm.sh
• charts/flyte-binary/Chart.yaml

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[lowc1012]

Root cause:
In generate_helm.sh, we uses latest norwoodj/helm-docs which requires go1.22
norwoodj/helm-docs@6cdd5ff

But flyte targets go1.21, so that it failed to generate helm-doc
https://github.com/flyteorg/flyte/blob/master/go.mod#L3

[davidmirror-ops]

Fixed by #4995