search

teamhephy / workflow

Hephy Workflow - An open source fork of Deis Workflow - The open source PaaS for Kubernetes.
MIT License
406 stars 37 forks source link

Helm Hub - missing README #94

Open kingdonb opened 5 years ago

kingdonb commented 5 years ago

We should review the best practices for listings on Helm Hub and ensure that all of our hephy repo projects are properly listed.

If you visit https://hub.helm.sh/charts/hephy/workflow right now, for example, you get a spinny wheel because we haven't included a README properly. Also the Maintainers block in the sidebar is not populated.

Cryptophobia commented 5 years ago

Sure, we should do this in order to get better visibility and make our charts nicer. :+1:

kingdonb commented 5 years ago

It turns out the README.md must go inside of the chart itself, on the chartmuseum server.

I'm looking at https://github.com/helm/chart-testing to see if there's more that we can do to bring our charts all the way into line with helm chart best-practices.

I used it against the workflow repo, and my untarred fetch of the workflow chart. So far I haven't been able to get it to give me any linting failures.

Either it tells me everything is fine (from the workflow.git repo):

------------------------------------------------------------------------------------------------------------------------
All charts linted successfully
------------------------------------------------------------------------------------------------------------------------
No chart changes detected.
------------------------------------------------------------------------------------------------------------------------

...or it tells me apparently that I'm not using it right (from my installed/untarred helm fetch):

------------------------------------------------------------------------------------------------------------------------
Error linting charts: Error identifying charts to process: Error running process: exit status 128
------------------------------------------------------------------------------------------------------------------------
No chart changes detected.
------------------------------------------------------------------------------------------------------------------------

I'm going to assume the charts aren't perfect and both messages actually mean I'm not using it right. But I guess it's possible they could have linted the charts before v2.18.0 and actually there are no linting failures. (I think these chart linting tools are new, but I guess that doesn't mean the rules that they consider as best-practices are new.) I'll have to try it on some charts I've built with less care and attention, or make something wrong on purpose just to see exactly which it is.

Anyway, I notice that v2.21.0 is out now! Woohoo. I just ran the upgrade. It matches the last beta that I ran, and that has already been running for 5 days on my staging cluster, with no surprises.

I'll go update the blog so it mentions the new latest release! Go Team Hephy