spezifisch / stmps

Subsonic Terminal Music Player S
GNU General Public License v3.0
19 stars 6 forks source link

Add a change log #65

Open xxxserxxx opened 1 month ago

xxxserxxx commented 1 month ago

With the merge of the tviewcommand work, old config file files become invalid, and stmps fails to start. While this should probably be addressed by config migration code, it does highlight the need for a CHANGELOG file where breaking changes can be called out for packagers and users. CHANGELOGs are generally useful for users in any case.

There's a sort of spec for change logs. I tend to omit the preamble, and I generally disagree with the Unreleased format including versions, because it creates a lot of unnecessary diffs, but most importantly, I think if we use something like this, it's going to have to be mandated by you @spezifisch, b/c it's really something that's going to have to be maintained in main. It makes more work for the maintainer.

In any case, that's my suggestion, and FYI HEAD breaks on old config files and it isn't clear what users need to do to fix their configs without digging into the sourcecode.

spezifisch commented 1 month ago

In any case, that's my suggestion, and FYI HEAD breaks on old config files and it isn't clear what users need to do to fix their configs without digging into the sourcecode.

Working on a fix.

Edit: fixed in my dev and backported to main. Thanks for the notice.

xxxserxxx commented 1 month ago

Edit: fixed in my dev and backported to main. Thanks for the notice.

Man, I edited that out so fast after I posted it, but of course you saw it in email. I knew you were in the middle of a complex merge; I just typed faster than I thought. Always dangerous. :-)