Changelog for the new releases / tags.

[marvin8]

Problem

I have looked through the repo and on tryke.dev and haven't found anywhere that documents changes from one release to the next (i guess tryke is using tags instead of releases). Without that information I find it hard to judge how quickly I want to adopt a new version.

Proposed solution

I would love to see a Changelog with all the changes documented and grouped by releases (or tags in tryke's case)

You can have a look at the following as an example of a Changelog on one of the projects I maintain:

    https://codeberg.org/marvin8/zaojun/src/branch/main/CHANGELOG.md

Maintaining a changelog can be automated so it doesn't cause extra work. The above changelog is generated from commit messages with git cliff

Alternatives considered

No response

Area

unsure

[thejchap]

@marvin8 thanks for the push on this. Is there a changelog generation tool you like/can recommend?

[marvin8]

Yeah, I use git-cliff.
it seems to work well for the way I think :)

I like that it is divorced from actually cutting a release.

I use just with a justfile to cut releases. In the justfile I have defined that as part of cutting a release it updates my changelog, then pauses, so I can any manual edits to the changelog before then commiting the changelog and creating a new release.

You can use my repo for Zaojun as an example, if you like.
The main files to look at for how I cut a release are cliff.toml and justfile. There is also a [bumpversion] section in my pyproject.toml file to help with cutting a new release.

[thejchap]

helpful, thanks!

i am currently working on some hardening after porting the homeassistant/fastapi test suites over to tryke, then will look into this. you're welcome to open a pr as well if that interests you!

[marvin8]

Sure... I'll have a go. Feel free to assign this issue to me.
Give me a couple of days and I hope to have something to show :)

[marvin8]

When you feel like it, have a look at #110

Let me know if you want me to change anything.

Ooh and just for full disclosure I had Claude Code help me with some edge cases.