The docs/changelog.md file is getting huge, ~2500 lines at time of writing, covering changes for 39 releases since 2019.
Having a single file for all changes has a few drawbacks though 🤔:
- It is hard to search for changes in a single release
- The doc page is very long, when we usually only need the infos for last release
- PRs generate conflicts every time they add a change entry in the same section
👉 I'd like to suggest to split the big changelog file into separate file for each release (will appear as separate pages in the website)
We loose global search across all changes, but I don't think it's very used, and having a better search engine on the website could help for that 🤔
However this doesn't fix the conflicts from PRs..
👉 We could go a bit further and require a separate file per PR (with 1-2 lines for the changes of that PR), or per new/changed features, and those will be merged at release time in the file for that release.
What do you think?
The
docs/changelog.mdfile is getting huge, ~2500 lines at time of writing, covering changes for 39 releases since 2019.Having a single file for all changes has a few drawbacks though 🤔:
👉 I'd like to suggest to split the big changelog file into separate file for each release (will appear as separate pages in the website)
We loose global search across all changes, but I don't think it's very used, and having a better search engine on the website could help for that 🤔
However this doesn't fix the conflicts from PRs..
👉 We could go a bit further and require a separate file per PR (with 1-2 lines for the changes of that PR), or per new/changed features, and those will be merged at release time in the file for that release.
What do you think?