axodotdev / axodotdev/cargo-dist
Manual release notes, or from NEWS.md?
- Dominant language
- Rust
- Stars
- 2.1k
- Forks
- 149
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 32
Description
Today the generated GitHub Release objects have a lot of text that is very focused on download URLs.
However, Releases are surfaced in the activity feed, and so I feel like this is a bit of a missed opportunity to tell users what's new and exciting in this release.
I would like if either
1. I could write custom text for the release, or
2. cargo-dist could somehow extract the relevant part from my NEWS.md
I can approximate the first by letting it create a release and then editing it myself, which isn't terrible.
By way of an example in the bit above the line is what I added and the bit below the line is what was generated.
This is how it looks in after edits, which I think shows why I care about what's at the top of the release.
(Apologies if this is already configurable and I missed it in the manual.)
Contributor guide
Research direction
Start by reading cargo-dist's release generation configuration and the existing NEWS.md convention. Trace how generated GitHub Release objects are assembled, then define how custom release text or relevant NEWS.md content would be selected; done means a release can show user-facing notes above the generated download details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, rust
- Domain
- release, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100