canboat / canboat

CAN Boat provides NMEA 2000 and NMEA 0183 utilities. It contains a NMEA 2000 PGN decoder and can read and write N2K messages. It is not meant as an end-user tool but as a discovery mechanism for delving into NMEA 2000 networks.
Other
533 stars 180 forks source link

Versioning schema and mechanism #123

Closed tkurki closed 6 years ago

tkurki commented 6 years ago

The output formats of analyzer, especially the JSON output and pgns.json|xml, constitute a public API that other software depend on. Changes like 9dc6a4b9961d95978fd40a819d4af6801398f2df break things downstream.

Canboat has no versioning scheme and there is no way a 3rd party app can detect what version of analyzer it is dealing with. As canboat is installed from git there should be an easier way than to refer to a specific commit to install a fixed version rather than "latest", eg. master.

I believe semantic versioning would work here.

There should be a versioning scheme and preferably release notes/changelog, manifested in

tkurki commented 6 years ago

Nice!

Can you get the version of the various utilitirs from the command line? Useful for detecting what the user is running and prompting for upgrades.

I have found a changelog based on pull requests good bang for the buck.

https://github.com/SignalK/signalk-server-node/blob/master/CHANGELOG.md#v170-20181001-1945-0000