On Thu, Dec 16, 2021 at 09:40:46PM +0000, Stuart Henderson wrote: > On 2021/12/16 11:27, Aaron Bieber wrote: > > Hi, > > > > Here is an update to headscale, I have been running it for some time > > without issue. > > > > It introduces a config change (json to yaml) - so the old config > > breaks. I am not sure how to handle that. Quirk? FAQ? Cry?! > > I would normally only add an faq/current.html entry if something will > break badly in some way that is especially hard to figure out, or > requires work *before* the update. Alternatively there's the @ask-update > mechanism, but people trying to do automated updates will be annoyed if > you use it too much. > > For much software it would not be unusual for an update to need some > work and that would usually be documented upstream, I don't think we > need to repeat that. > > For this particular case I think I would note it in the commit log > and *maybe* pkg/README if it's hard to find info in upstream docs.
What about MESSAGE? Quite a few ports use it to tell users about initial one-shot steps (routinator), major changes in updates (puppet 6) and required changes after updates (xmms2-scrobbler).
