Skip to content

Enhancement: add changelog to release workflow #133

@rocketman-code

Description

@rocketman-code

Current Behavior

The project explicitly has no changelog (releases.md line 48-49: "No CHANGELOG.md file. Commit messages use conventional commits. GitHub releases with auto-generated notes from tags are sufficient.").

GitHub's auto-generated release notes produce an unsorted list of PR titles with no categorization, no migration guidance, and no editorial curation.

Expected Behavior

Users of the published crate should be able to read a curated, human-written summary of changes between versions, organized by category (added, changed, fixed, removed).

Context

Rust for Rustaceans (Ch5 Section 7d) strongly recommends maintaining a manual changelog over auto-generated git logs. The project already uses conventional commits with strict scoping, which provides excellent raw material. The gap is the editorial step of curating those into user-facing release notes.

chainsaw is published on crates.io and consumed by external users who need to understand what changed between versions without reading commit history.

Technical Details

Relevant Code

docs/standards/releases.md:48-49

No CHANGELOG.md file. Commit messages use conventional commits.
GitHub releases with auto-generated notes from tags are sufficient.

docs/standards/releases.md:29-45 -- release checklist has no changelog step

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Low priorityenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions