Now that we'll start working on Elgg 2.0 we will make breaking changes that include simply getting rid of stuff.
For example: https://github.com/Elgg/Elgg/pull/8147
Should we add a new commit message type for commits that remove stuff?
info@elgg.org
Security issues should be reported to security@elgg.org!
©2014 the Elgg Foundation
Elgg is a registered trademark of Thematic Networks.
Cover image by RaĆ¼l Utrera is used under Creative Commons license.
Icons by Flaticon and FontAwesome.
- Juho Jaakkola@juho.jaakkola
Juho Jaakkola - 0 likes
- Juho Jaakkola@juho.jaakkola
Juho Jaakkola - 0 likes
- Jeroen Dalsem@jdalsem
Jeroen Dalsem - 0 likes
- buule@buulejon
buule - 0 likes
- ihayredinov@ihayredinov
ihayredinov - 0 likes
- twentyfiveautumn@socialphp
twentyfiveautumn - 0 likes
- Evan Winslow@ewinslow
Evan Winslow - 0 likes
- Juho Jaakkola@juho.jaakkola
Juho Jaakkola - 0 likes
- Evan Winslow@ewinslow
Evan Winslow - 0 likes
You must log in to post replies.Or do we in fact already have one: https://github.com/Elgg/Elgg/blob/master/.scripts/write-changelog.js#L16
That type hasn't been documented anywhere. I don't think it has been used either.
This one got its own "Breaking Changes" section in the changelog: https://github.com/ewinslow/Elgg/commit/c3b0d8bcf700e978833d1785c23ae0dbefa2280c
It simply says "BREAKING CHANGE:" in the description part of the commit message.
yeah but that is still a chore... with a breaking change... but that will not show up in the release notes
Some things I would suggested could be removing the custom index,get a cover page for elgg and also create a notifications plugin just like twitters!
And solve global warming while at it... How did we get from commit message type to twitter notifications remains a mystery
okay, I'll get started on that global warming plugin ;)
@Jeroen, all breaking changes show up in release notes, even chores.
I think the current options we have are fine. If we are extracting the code to another repo in a way that should be seamless to clients, then chore. If we are deleting deprecated code, then "break." If we are adding new features/fixing bugs in a breaking way, then fix/feature with "BREAKING CHANGE" in the description.
@ewinslow I started this thread because I was not aware of the "break" commit type. It hasn't been documented anywhere.
Also I'm still not sure if adding "BREAKING CHANGE" in the description actually triggers something when generating the changelog. Does it? If yes, how do you use it? What's the correct syntax?
Syntax is:
BREAKING CHANGE:
Description of breakage and how to migrate.