Two recent breaking features come to my mind:
- New way of iterating over content which broke multiple older themes (don’t remember which version)
- Goldmark renderer breaking HTML inside content
Both of them were introduced before any previous notifications, so multiple users (including me, both times) updated Hugo, built website and uploaded it after changing little things and only later realising that their page is broken.
While the changes themselves are OK, I think the way they’re introduced could be improved.
Standard practice is to issue warnings during compilation when something is going to be deprecated soon. It would remedy lot of pain for many people surprised by those changes coming out of nowhere.
Secondly, I think those breaking changes should be more prominent within release notes themselves. Example from 0.60.0:
Also, if you have lots of inline HTML in your Markdown files, you may have to enable the
Sounds like not very important side note, but actually tells about something very big for many people. Just bolding this text would do wonders.
In before “RTFM before updating”, I believe what I described above is just common sense and being nice to users. We don’t follow release notes, news and monitor every change, so it’s very easy to be caught with pants down.