csofranz/DML

Changelog

Opened this issue · 2 comments

PatZab commented

We are in heavy use of your library. When updates occur, it is not really obvious what has been changed.
Is it possible to get a changelog?

csofranz commented

Thank you for your message. I strongly recommend that you monitor the DML main thread here
https://forum.dcs.world/topic/290975-dml-mission-creation-toolbox-no-lua-required/

Below is the change log and discussion for today's release:
https://forum.dcs.world/topic/290975-dml-mission-creation-toolbox-no-lua-required/?do=findComment&comment=5549227

I hope that you find that helpul

zeathe commented

Very very polite ask from a consumer -- TL;DR:

  • Please use the release mechanisms in github and duplicate the release notes between here and the DCS forums
  • Please use a more detailed CHANGELOG
  • Please use semver to show breaking changes

... Text wall of supporting details below....

As a library consumer, I would really really be appreciative if semver were followed with regards to functionality changes and removals. I would also highly encourage something similar to https://keepachangelog.com/en/1.0.0/ to track various changes and call out deprecations and removals of functionality.

Consistent versioning of DML over-all and/or each module within DML may help consumers identify when to take a closer look before pulling in updates.

I know that there is a "VERSION HISTORY" block in the head comments of most module files, but it's hard to track the overall group of changes. I know you'll bump a release comment on the DML thread in the forums... BUT.... I would highly encourage you to leverage the release feature of Github just to leave the notes here with a true CHANGELOG. The changelog comment on the DCS forum for DML can get lost in the chatter on the forums release thread. You can easily copy/pasta the release notes block into the forums from here.

As an example, for me, I just found out that masterOwner looks to be deprecated/removed in the ownedZones module -- but some of the masterOwner logic is still in the update flow. Git blame shows the following:

7e4c1470 modules/ownedZones.lua    (Christian Franz 2024-04-18 11:31:07 +0200  44)        - code clean-up
07a32bd0 modules/ownedZones.lua    (Christian Franz 2024-05-09 09:39:22 +0200  45) 2.3.1 - restored getNearestOwnedZoneToPoint
f7a8705a modules/ownedZones.lua    (Christian Franz 2024-08-15 11:36:45 +0200  46) 2.4.0 - dmlZones masterOwner update
69530394 modules/ownedZones.lua    (Christian Franz 2024-08-29 10:44:52 +0200  47) 2.4.1 - conquered flag now correctly guarded in loadData()
f7a8705a modules/ownedZones.lua    (Christian Franz 2024-08-15 11:36:45 +0200  48)

... so commit f7a8705a is what I'm interested in... but in the notes in the ownedZones LUA, it says v2.4.0:

2.4.0 - dmlZones masterOwner update

In the commit message itself for f7a8705a, it says Version 2.3.0 (overall DML version) -- from my experience going through your code, I think you version each module individually and then there's an overall "meta" release. This is illustrated above with ownedZones, the DML module was v2.4.0 within the overall DML meta release version 2.3.0.

  • 👍1