axodotdev / axodotdev/cargo-dist
Don't assume release notes are markdown?
Open
bug
- Dominant language
- Rust
- Stars
- 2.1k
- Forks
- 149
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 32
Description
Currently we'll detect and slurp up RELEASES.rst but then embed the contents in markdown. Oops!
I don't know if Github Releases supports not-markdown, or if we actually need to convert the user's notes to markdown.
Contributor guide
Research direction
Inspect the code path that detects and embeds RELEASES.rst, then verify whether GitHub Releases accepts reStructuredText or requires Markdown. Confirm the expected behavior for non-Markdown release notes and make the handling consistent with that requirement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- release
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100