From 984c4c8af993923c53848346b99fea0cffd77841 Mon Sep 17 00:00:00 2001 From: Marco Pivetta Date: Sun, 17 Jan 2021 17:58:28 +0100 Subject: [PATCH 1/2] Suggest dropping `CHANGELOG.md` due to increased maintenance effort (merge conflicts) --- meetings/agenda.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/meetings/agenda.md b/meetings/agenda.md index 81592b3..4060f51 100644 --- a/meetings/agenda.md +++ b/meetings/agenda.md @@ -7,3 +7,13 @@ 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. From b2068127f97047f3711cadafb509cff4341e4a8e Mon Sep 17 00:00:00 2001 From: Marco Pivetta Date: Sun, 17 Jan 2021 18:00:19 +0100 Subject: [PATCH 2/2] Added examples of `CHANGELOG.md` being detrimental to maintenance work --- meetings/agenda.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/meetings/agenda.md b/meetings/agenda.md index 4060f51..e45cbb9 100644 --- a/meetings/agenda.md +++ b/meetings/agenda.md @@ -17,3 +17,8 @@ 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