Possibly add Changelog?

[joshpetit]

Hey! Nvim-org is awesome! And as more features get added it would be really easy for us to get updated on features that are now added and usable if there was a changelog saying what's been added. If you'd be up for that or making that a prerequisite for PRs I think it'd be a large help in staying up to date with the project!

[kristijanhusak]

Hey,

I agree that proper changelog would be helpful, but I didn't investigate some automatic ways how to generate it. Currently creating a release allows generating changelog to some extent by Github (example: https://github.com/nvim-orgmode/orgmode/releases/tag/0.2.1), but this registers only PRs. If i push something directly to master it is not shown.

Do you know some tools that could help me on this to automate it?

[joshpetit]

No i don't know of any automated tools for this. But if it's a requirement for everyone to update the changeling when they add a feature it shouldn't be too much of a burden, considering we have to update the readme regardless.

I'm assuming the difficulty would be in making it match release versions in an automated way wouldn't it? I'm not really sure regarding that 😅.

[jgollenz]

If i push something directly to master it is not shown

release-drafter solved this by marking them as uncategorized changes. I did not test this action, but it looks like a good start. Perhaps they will add conventional commits in the future, making it even easier to categorize some loose pushes to master.

[jgollenz]

@kristijanhusak are you still interested in automating changelogs? Just found release-please and they also address the issue you brought up. Looks like it may require us to use conventional commits, but I don't consider that a bad thing tbh.