search

stencilproject / Stencil

Stencil is a simple and powerful template language for Swift.
https://stencil.fuller.li
BSD 2-Clause "Simplified" License
2.34k stars 221 forks source link

Reorder empty Changelog sections to match the old order #232

Closed djbe closed 5 years ago

djbe commented 5 years ago

Adresses https://github.com/stencilproject/Stencil/commit/1b85b816fd96118d491e8e2ada90dccc75b7573f#commitcomment-30368612.

djbe commented 5 years ago

Pinging @kylef, because he wanted to discuss this.

yonaskolb commented 5 years ago

For what it's worth I like the sections from https://keepachangelog.com/

kylef commented 5 years ago

FWIW, I am not against changing the format.

I just wanted to open the discussion so that we could agree upon what the format is going to be, since it was comitted directly to master it can be a little hidden and harder for others to know that the format is different. Someone doing a future release could revert back to the format by mistake (especially if they're committed directly to master without review). We should strive for consistency.

I've added a feature to maintain to allow it to have user-configurable semantic changelog sections (https://github.com/kylef/maintain/pull/24) so that it can support projects that invent their own semantics outside of the changelog spec.

For what it's worth I like the sections from keepachangelog.com

One annoyance I have with keepachangelog is the semantics behind some of the change sections are not clear. "Changed" for example, does that map to a major, minor or patch release? I could change features in both breaking and non-breaking ways in the same change section which makes it hard to know the semantics behind the change for both the audience of the changelog and the releaser.

Since it isn't clear, you cannot have any tooling or verification checking for the release version against the changelog. Semantic changelog allows you to look at the unreleased state and easily determine what the next semantic versioned released would be, or better yet tooling can do it for you.

djbe commented 5 years ago

@kylef Did you use maintain for previous releases? Or do you have specific steps for the release process in Stencil? Might be good to document these somewhere (wiki, .md file, ...) so we can have a consistent process.

djbe commented 5 years ago

Closing this as for now (we've had a few releases since this PR started). The current order is:

If anyone would like to further discuss this, please open an issue for it.