Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
JohnTitor opened this issue May 12, 2022 · 4 comments · Fixed by #781
Closed

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

JohnTitor opened this issue May 12, 2022 · 4 comments · Fixed by #781

Comments

@JohnTitor
Copy link
Contributor

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
Copy link
Member

ahmetb commented May 12, 2022

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
Copy link
Contributor Author

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

@JohnTitor
Copy link
Contributor Author

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 2k36@d1e569a, 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
Copy link
Member

ahmetb commented May 25, 2022

Yeah that'd be appropriate!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants