Skip to content

Drop calens in favor of conventional commits #11255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LukasHirt opened this issue Apr 22, 2025 · 0 comments
Open

Drop calens in favor of conventional commits #11255

LukasHirt opened this issue Apr 22, 2025 · 0 comments

Comments

@LukasHirt
Copy link
Contributor

Preamble

There is a few things that are rather annoying about the current changelog process:

  • requires a manual extra step
  • needs to sync link to a PR that does not exist yet (or requires additional push)
  • is not clear to contributors immediately because the check happens in PRs

Proposed solution

Drop calens and instead use conventional commits. Some of us are already doing it anyway. We could then build changelog from such commits.

Requirements

  • old changelog items are persisted
  • there is a commit hook checking whether the commit follows conventional commits
  • new changelog items are created from the git history (we need to find a solution to set from which commit not to recreate the calens items)

Open questions

  • Do we still keep the unreleased section of changelog or simply build changelog only on releases?
  • Should we still omit certain types of changes or print everything into the changelog?
    I get the idea behind hiding "technical" stuff from end users, but I think it makes actually sense to keep everything in the changelog here on GH. User facing changelog can be then shown e.g. on our website, blog post, etc. and there we can omit them but on GH are devs. And as a dev I would actually really want to see that in this release, some existing features are better covered by tests, some refactor happened and the app might get faster, some deps have been updated, etc.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Qualification
Development

No branches or pull requests

1 participant