Resolve "Add Upstream Release Notes section to the `README.md.gotmpl` so that renovates can link to it consistently"

General MR

Summary

While working through renovate-runner#30 as part of the automate renovate ticket workflow epic, I submitted manual README updates to a number of BigBang packages. As you might expect, those started to break once maintainers reran their README generation scripts using the templates in this repository.

This MR updates the templates we all use to (re)generate our packages' README.md files so that upstream release notes can be pulled out of chart/Chart.yaml if they are logged using an annotation of this form:

annotations:
  bigbang.dev/upstreamReleaseNotesMarkdown: |
    - [Find our upstream chart's CHANGELOG here](https://link-goes-here/CHANGELOG.md)
    - [and our upstream application release notes here](https://another-link-here/RELEASE_NOTES.md)

Relevant logs/screenshots

Happy path - gitlab package

• release notes link shows up as expected
• the leading "don't edit this file by hand" comment doesn't render in the browser

New footer with some "use gluon please" breadcrumbs

Sad path

If there is no bigbang.dev/upstreamReleaseNotesMarkdown key in a package's chart/Chart.yaml, the default output explains that there's no upstream release notes annotation in Chart.yaml for this package and describes how to accomplish that:

Linked Issue

N/A

Upgrade Notices

BigBang package maintainers will want to update their local helm-docs readme updater scripts to use version 1.14.2, up from the 1.10.0 we used previously.

Closes #43 (closed).

added statusdoing teamDevelopment & Ops labels

assigned to @dpritchettrm

added 12 commits

• 59cc6d8c...7906db61 - 2 earlier commits
• ce7878e6 - Bumps helm-docs recommendation from 1.10.0 to 1.14.2
• 9b103df7 - WIP adding example for missing release notes links
• b91eb680 - Adds notes to README template to ward off manual edits
• b9911951 - README template copy edit
• fadf3980 - README template copy edit
• db815023 - README template copy edit
• d0595486 - README template copy edit
• 68995251 - README template copy edit
• b0190d97 - Updates helm-docs ref from 1.10.0 to 1.14.2 in two more places
• 018e97e4 - README template copy edit

Compare with previous version

added statusreview label and removed statusdoing label

marked this merge request as ready

changed the description

changed title from Resolve "Add Upstream Release Notes section to the README.md.gotmpl so that renovates can link to it consistently" to Resolve "Add Upstream Release Notes section to the README.md.gotmpl so that renovates can link to it consistently" | SKIP UPDATE CHECK

changed title from Resolve "Add Upstream Release Notes section to the README.md.gotmpl so that renovates can link to it consistently" | SKIP UPDATE CHECK to Resolve "Add Upstream Release Notes section to the README.md.gotmpl so that renovates can link to it consistently"

added 1 commit

• 23a54ce7 - Bumps chart to 0.5.1

Compare with previous version

added 1 commit

• 0d61a231 - Bumps CHANGELOG

Compare with previous version

added 1 commit

• e99d3cc9 - Bumps version in validate-chart/Chart.yaml

Compare with previous version

requested review from @jeffv and @obuh.alozie

requested review from @cshannon and @justin.gomez

requested review from @danilo-patrucco

requested review from @jamie.causey, @jimmy.bourque, @alieberman, and @julian.hair and removed review request for @cshannon

requested review from @jaredmladner

approved this merge request

mentioned in commit 92ba98e4