search

turnkeylinux / tracker

TurnKey Linux Tracker
https://www.turnkeylinux.org
69 stars 16 forks source link

New changelogs should mention which version of core's changelog it tracks #1554

Open OnGle opened 3 years ago

OnGle commented 3 years ago

As versions are now somewhat disjointed it is no longer always clear which "core changelog" an appliance is refering too in the changelogs. As for example a v16.2 could be built off a v16.0 core. As such the following changelog snippet should be used

  * Note: Please refer to turnkey-core's $VERSION changelog for changes common
    to all appliances. Here we only describe changes specific to this appliance.

where $VERSION is $MAJOR.$MINOR for example:

(@JedMeister)

E.g. for v16.1 appliances:

  * Note: Please refer to turnkey-core's 16.1 changelog for changes common to
    all appliances. Here we only describe changes specific to this appliance.
JedMeister commented 3 years ago

Attention @qq7 - Just wanting to draw your attention to this for v16.1 updates. Please treat the suggestion posted by @OnGle as the canonical text for providing as the last point within all v16.1 appliances' changelogs. i.e. copy/paste this as the last part of an applaince changelog.

OnGle commented 3 years ago

@JedMeister not sure what to do with this. Presumably this applies to all subsequent releases, and won't ever be finished, thoughts?

JedMeister commented 3 years ago

@OnGle

Presumably this applies to all subsequent releases, and won't ever be finished

Yes, good point! Perhaps what is need to close this issue is add it into the TKLDev docs? IIRC there is a doc that covers writing changelogs and changelog entries.

Also, perhaps we need to have a policy doc somewhere that covers this too?

Thoughts?