search

waycrate / swhkd

Sxhkd clone for Wayland (works on TTY and X11 too)
https://git.sr.ht/~shinyzenith/swhkd
BSD 2-Clause "Simplified" License
679 stars 47 forks source link

Add changelog #181

Closed ajanon closed 1 year ago

ajanon commented 1 year ago

We're currently missing a changelog file. Having a changelog file directly inside the repository would help track changes. This would also make it easier to create new releases as we could just copy and paste what is already available in the changelog file.

I would suggest using something like Keep a Changelog for this. We can add this file with the latest changes only for now, and try to add previous releases to this file gradually later on.

We could also enforce updating the changelog on PRs to ensure we do have everything in there.

This issue is mainly to discuss this and to think about possible solutions.

Shinyzenith commented 1 year ago

This is a good suggestion, one that we should've adopted early on. I think this would be great to implement. Is there anyway to ensure that changelog files are edited in PR's using github actions?

ajanon commented 1 year ago

I haven't looked too much into the interaction with GitHub actions. Should we really automate this, though? Some PRs might not be necessary to document in the public-facing changelog. For instance, I don't think it is necessary to document refactors if there is no behavior change.

I feel like we should check it manually to start with, and once we have more experience with this, we could look into more automation.

What do you think?

Shinyzenith commented 1 year ago

Yep that makes sense. Shall we get started with 1.3.* release tag?

oneingan commented 1 year ago

Maybe you feel this interesting https://github.com/cocogitto/cocogitto

Shinyzenith commented 1 year ago

Indeed looks like an interesting project! If we adapt conventional commits, this can help us even more.

ajanon commented 1 year ago

189 got merged, we can close this.

The commit format should be a separate issue.