Skip to content
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.

Sign up for GitHub

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

Suggest dropping CHANGELOG.md due to increased maintenance effort (merge conflicts) #59

Merged
merged 2 commits into from
Jan 18, 2021
Merged

Suggest dropping CHANGELOG.md due to increased maintenance effort (merge conflicts) #59

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
984c4c8
Suggest dropping `CHANGELOG.md` due to increased maintenance effort (…
Ocramius Jan 17, 2021
b206812
Added examples of `CHANGELOG.md` being detrimental to maintenance work
Ocramius Jan 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions meetings/agenda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,18 @@ Please file pull requests to add, or discuss items to add, to the agenda.

## Items to discuss

### Drop `CHANGELOG.md` from repositories when it leads to merge conflicts

`CHANGELOG.md` is more hindrance than help: we keep our changelog in the `git tag` history, as well
as under the release history on github. Having `CHANGELOG.md` as part of the repository leads to
slower merge-up workflow when dealing with bugfixes, and we already have a all the information in
the repository history, as well as on github.

An alternative suggested approach could be to generate a `CHANGELOG.md` in the documentation build,
by picking the list of pre-existing tags and unrolling it in that process, therefore removing the
need for keeping a build artifact in the repository.

Examples:

* https://github.com/laminas/laminas-servicemanager/pull/76
* https://github.com/laminas/laminas-mail/pull/125 merge-up actively interrupted a productive day of merge/release there: https://github.com/laminas/laminas-mail/pull/125#issuecomment-752996771