Skip to content

Commit

Permalink
Merge pull request #59 from laminas/suggest-removal-of-changelog
Browse files Browse the repository at this point in the history
Suggest dropping `CHANGELOG.md` due to increased maintenance effort (merge conflicts)
  • Loading branch information
weierophinney authored Jan 18, 2021
2 parents 9b39e44 + b206812 commit d599c34
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions meetings/agenda.md
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

0 comments on commit d599c34

Please sign in to comment.