axodotdev / axodotdev/cargo-dist

Correct location / specification for a changelog/releases notes?

Open
#2,053 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2.1k
Forks
149
Avg merge
1d 11h
Merged PRs (30d)
32

Description

Per the [docs](https://axodotdev.github.io/cargo-dist/book/workspaces/simple-guide.html#release-notes), `dist` will use a changelog/releases file when producing a release. I've verified that `parse-changelog` applied to [my changelog](https://github.com/bjones1/CodeChat_Editor/blob/main/docs/changelog.md) produces correct output. I've also specified its location in my [dist.toml](https://github.com/bjones1/CodeChat_Editor/blob/main/server/dist.toml) file:

```toml
[package]
changelog = "../docs/changelog.md"
```

However, the changelog isn't used when generating release announcements. Is this bug, or am I missing a setting?

Thanks!

Contributor guide

Open the contributing guide

Research direction

Start with the release-notes section of the linked documentation and compare it with the package configuration in server/dist.toml and the changelog at docs/changelog.md. Reproduce release announcement generation using that configuration, then verify whether the configured changelog is read and whether the documentation matches the observed behavior.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.