Rebuilds README to include release notes from Chart.yaml via gluon template
General MR
Summary
Second attempt to add some standard ### Upstream Release Notes
text in the README
for the ongoing renovate epic. Previously I'd added this by hand, forgetting that I'd need to update gluon
to make it stick (gluon rolled it back in the next MR: !254 (merged)). I've updated gluon
, so we should be able to lock this in.
Relevant logs/screenshots
❯ make update-readme
curl -sLO https://repo1.dso.mil/big-bang/apps/library-charts/gluon/-/raw/master/docs/README.md.gotmpl
curl -sLO https://repo1.dso.mil/big-bang/apps/library-charts/gluon/-/raw/master/docs/.helmdocsignore
curl -sLO https://repo1.dso.mil/big-bang/apps/library-charts/gluon/-/raw/master/docs/_templates.gotmpl
docker run --rm -v "`pwd`:/helm-docs" -u 501 jnorwood/helm-docs:v1.14.2 -s file -t /helm-docs/README.md.gotmpl -t /helm-docs/_templates.gotmpl --dry-run > README.md
time="2024-07-24T21:17:32Z" level=info msg="Found Chart directories [chart]"
time="2024-07-24T21:17:32Z" level=info msg="Generating README Documentation for chart chart"
rm .helmdocsignore README.md.gotmpl _templates.gotmpl
Linked Issue
N/A
Upgrade Notices
N/A
Edited by Daniel Pritchett