Skip to content

Conversation

@IshaanDesai
Copy link
Member

@IshaanDesai IshaanDesai commented Oct 8, 2025

Title is self-explanatory. I only added entries to the changelog after the last release.

@IshaanDesai IshaanDesai self-assigned this Oct 8, 2025
@IshaanDesai IshaanDesai requested a review from MakisH October 8, 2025 08:43
@MakisH
Copy link
Member

MakisH commented Oct 8, 2025

Good point, thank you!

In other repositories, we use a system in which we collect changelog entries in a specific directory. This has the advantage of not running into merge conflicts (which will always happen).

I would rather introduce that system here first, and create a changelog file with the next release. There, we can also use https://keepachangelog.com/en/1.1.0/, and I could collect changelog entries from previous releases as well.

@IshaanDesai
Copy link
Member Author

I would rather introduce that system here first, and create a changelog file with the next release. There, we can also use https://keepachangelog.com/en/1.1.0/, and I could collect changelog entries from previous releases as well.

Good point. I will add separate files in a dedicated folder.

@IshaanDesai
Copy link
Member Author

@MakisH I now put all the changelog entries since the last release in separate files, in docs/changelog/.

@MakisH
Copy link
Member

MakisH commented Oct 8, 2025

I would still like to do some work on the same branch, give me a few days.

@IshaanDesai
Copy link
Member Author

I would still like to do some work on the same branch, give me a few days.

Shall we merge this branch?

@MakisH MakisH changed the title Add a CHANGELOG file because there isn't one at the moment Add a CHANGELOG file Nov 7, 2025
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking another look, I think that this repository is not active enough to justify a changelog-entries/ workflow, which would be a bit more annoying (one has to first get the number of the PR to create the file). We can always reintroduce such a workflow without any changes to the file.

I added a CHANGELOG.md based on the keeachangelog format, and transferred the past entries from the Releases here, adjusting for consistency. I also added numbers and links to all PRs (besides the one for v2.20, which I think the commits were scattered).

@MakisH MakisH self-assigned this Nov 7, 2025
@MakisH MakisH merged commit 4f77d58 into develop Nov 7, 2025
3 checks passed
@MakisH MakisH deleted the add-changelog branch November 7, 2025 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants