SKIP UPDATE CHECK Resolve "Replace asterisk with dash to appease markdownlint"

General MR

Summary

helm-docs uses an asterisk for its chart.sourcesList template, but our markdownlinter rules would really like those asterisks to be dashes

Relevant logs/screenshots

https://repo1.dso.mil/big-bang/product/packages/promtail/-/jobs/41525806#L41

Linked Issue

#61 (closed)

Upgrade Notices

N/A

Closes #61 (closed)

added teamPipelines & Infrastructure label

assigned to @peter.sigur

added 1 commit

• a207a662 - Update README.md.gotmpl

Compare with previous version

Doesn't look like a valid change for README.md.gotmpl:

time="2025-01-13T22:12:55Z" level=warning msg="Error generating gotemplates for chart chart: template: chart:14: function "include" not defined"

Will try overriding chart.sourcesList in _templates.gotmpl instead.

added 2 commits

• 239751ef - revert readme template change
• 1069cb7d - test replacing chart.sourcesList template

Compare with previous version

added 1 commit

• 7ea06781 - test removing extra line breaks

Compare with previous version

added 1 commit

• 1183e7e8 - more line breaks

Compare with previous version

added 1 commit

• a37f3666 - now that's what I call line breaks

Compare with previous version

added 1 commit

• 56f2a64d - more line break tweaks

Compare with previous version

added 1 commit

• bc9d7ba4 - more line break tweaks

Compare with previous version

added 1 commit

• 51272489 - more line break tweaks

Compare with previous version

added 1 commit

• 2990decf - more line break tweaks

Compare with previous version

added 1 commit

• 86d43c3b - more line break tweaks

Compare with previous version

added 1 commit

• 4b85f1c0 - more line break tweaks

Compare with previous version

added dogfood kinddocs labels

removed dogfood label

changed title from Draft: Resolve "Replace asterisk with dash to appease markdownlint" to Draft: SKIP UPDATE CHECK Resolve "Replace asterisk with dash to appease markdownlint"

Tested locally with tweaked version of the readme alias, pointed to this feature branch:

alias readme_update='curl -LO https://repo1.dso.mil/big-bang/product/packages/gluon/-/raw/61-replace-asterisk-with-dash-to-appease-markdownlint/docs/README.md.gotmpl && curl -LO https://repo1.dso.mil/big-bang/product/packages/gluon/-/raw/61-replace-asterisk-with-dash-to-appease-markdownlint/docs/.helmdocsignore && curl -LO https://repo1.dso.mil/big-bang/product/packages/gluon/-/raw/61-replace-asterisk-with-dash-to-appease-markdownlint/docs/_templates.gotmpl && docker run --rm -v "`pwd`:/helm-docs" -u $(id -u) jnorwood/helm-docs:v1.14.2 -s file -t /helm-docs/README.md.gotmpl -t /helm-docs/_templates.gotmpl --dry-run >| README.md && rm .helmdocsignore README.md.gotmpl _templates.gotmpl'

Ran against promtail Renovate currently in progress: promtail!92 (merged), resulting in this diff of README.md:

diff --git a/README.md b/README.md
index 220d7500..935b7901 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,11 @@
 Promtail is an agent which ships the contents of local logs to a Loki instance

 ## Upstream References
-- <https://grafana.com/loki>

-* <https://github.com/grafana/loki>
-* <https://grafana.com/oss/loki/>
-* <https://grafana.com/docs/loki/latest/>
+- <https://grafana.com/loki>
+- <https://github.com/grafana/loki>
+- <https://grafana.com/oss/loki/>
+- <https://grafana.com/docs/loki/latest/>

 ## Upstream Release Notes

(END)

changed title from Draft: SKIP UPDATE CHECK Resolve "Replace asterisk with dash to appease markdownlint" to Draft: Resolve "Replace asterisk with dash to appease markdownlint"

marked this merge request as ready

added statusreview label

requested review from @alieberman, @daniel.stocum, @obuh.alozie, @jaredmladner, @jeffv, @julian.hair, and @akesterson

removed kinddocs label

changed title from Resolve "Replace asterisk with dash to appease markdownlint" to SKIP UPDATE CHECK Resolve "Replace asterisk with dash to appease markdownlint"

added debug label

added 14 commits

• 4b85f1c0...3b7057a6 - 2 commits from branch master
• 3b7057a6...e92bcc97 - 2 earlier commits
• d222c2ee - test replacing chart.sourcesList template
• c2c3ba27 - test removing extra line breaks
• 1eb97ee9 - more line breaks
• ddf9ee3f - now that's what I call line breaks
• 8db8141f - more line break tweaks
• 0b756f1a - more line break tweaks
• dc54fc4f - more line break tweaks
• bda2157a - more line break tweaks
• 1c95b2e8 - more line break tweaks
• 46cd39c2 - more line break tweaks

Compare with previous version

Does this cause issues of any sort, or should we just ignore the specific rule?

added 14 commits

• 46cd39c2...e4b01b37 - 2 commits from branch master
• e4b01b37...b6d46122 - 2 earlier commits
• 54930ea0 - test replacing chart.sourcesList template
• cb5e088c - test removing extra line breaks
• d9a83242 - more line breaks
• fe700a7c - now that's what I call line breaks
• 93eae6db - more line break tweaks
• 556cb33c - more line break tweaks
• e540dde2 - more line break tweaks
• 49e91aa4 - more line break tweaks
• 8e9d56cf - more line break tweaks
• fab171ac - more line break tweaks

Compare with previous version

resolved all threads

requested review from @michaelmartin and @chris.oconnell

lgtm

approved this merge request

merged

mentioned in commit edbeb4b7