mirror of
https://github.com/SabreTools/MPF.git
synced 2026-02-03 21:29:27 +00:00
[Request] Display version number, build date, and git commit in main MPF window title or about box #286
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @acdvorak on GitHub (Apr 13, 2021).
Originally assigned to: @mnadareski on GitHub.
Build metadata
As someone who frequently tests new WIP builds, it would be useful to have the following metadata in the main MPF window title and/or the about box:
WIPordevfor CI builds2021-04-13T05:36:07Z)Timestamp versioning
Example window titles:
MPF v1.18 (2020-11-10T19:20:48Z)MPF WIP (2021-04-13T00:05:16Z)Semantic versioning
You could consider switching to a version numbering scheme with 4 components (e.g.,
1.18.0.581), and auto-increment the fourth component on every commit (possibly using a presubmit hook), resetting it to zero on every major/minor/patch bump.This would make the window title shorter and easier to visually parse. E.g.:
MPF v1.18.0.0MPF v1.18.0.581 (WIP)Stable and dev channels
You might also consider switching to "stable" and "dev" channel nomenclature instead of "release" and "WIP". E.g.:
MPF v1.18.0.0 (stable)MPF v1.18.0.581 (dev)Personally, I would prefer semantic versioning with stable/dev channels: it's short, descriptive, easy to read and compare, and it doesn't require opening the about box to tell someone what version you're running.
About box
Since the about box is not space constrained like the title bar, it would be lovely to have each metadata property on its own line, with underlined hyperlinks where appropriate. E.g.:
Ideally, all text should be selectable with a mouse and a keyboard so that everything can be easily copied to the clipboard.
Bonus points for adding tooltips with the full URL of each hyperlink, and context menus to copy the URLs.