search

kubernetes-sigs / krew

📦 Find and install kubectl plugins
https://krew.sigs.k8s.io
Apache License 2.0
6.42k stars 369 forks source link

GitHub Release's body isn't rendered as Markdown #780

Closed JohnTitor closed 2 years ago

JohnTitor commented 2 years ago

See https://github.com/kubernetes-sigs/krew/releases/tag/v0.4.3. https://github.com/kubernetes-sigs/krew/releases/tag/v0.4.2 is rendered correctly, so there should be something between them.

image

ahmetb commented 2 years ago

That's a GitHub issue I think. Someone needs to manually copy those notes, click Edit on the release and paste them again, then it actually becomes markdown.

JohnTitor commented 2 years ago

I see, I'm going to check if there's a way to tell GitHub that it's markdown.

JohnTitor commented 2 years ago

Okay I found the cause. So, the problem is we don't pass the notes to GitHub but only include them in the git tag. GitHub will render the passed body as Markdown but if the body is empty, they will instead use git tag's description as plain text. For instance, if we pass the body like https://github.com/2k36/krew/commit/d1e569affd4b68499afecdd2a8eda4e7f2418e90, the notes are rendered intentionally: https://github.com/2k36/krew/releases/tag/v0.100.4 I'm happy to include this change to #781 if you'd like :)

ahmetb commented 2 years ago

Yeah that'd be appropriate!