search

madMAx43v3r / chia-plotter

Apache License 2.0
2.27k stars 662 forks source link

Added a --version option for displaying version info #952

Closed paninaro closed 3 years ago

paninaro commented 3 years ago

We'd like to display a version string for the madmax plotter in the Chia GUI and CLI. It wasn't immediately obvious where to pull an actual version from, so this PR introduces a --version option that emits a version string. For the moment the version string just references the date of the last commit made, but this could easily be changed to some other versioning scheme.

Is this a change that would be welcomed, or should we handle this separately/on our own?

madMAx43v3r commented 3 years ago

What about using GIT_COMMIT_HASH ?

paninaro commented 3 years ago

What about using GIT_COMMIT_HASH ?

Using the commit hash could work, but it wouldn't be possible to compare versions in code (i.e. is 0b9a44a newer than 666b66c?)

I do think it would be nice to have a version number that the user can look at and understand, as well as being able to compare versions in code. Using a date string like "2021.08.25" somewhat addresses the issue, though I think a true major.minor.patch (or similar) versioning scheme would be the most user-friendly. That said, if you'd rather stick with just the commit hash, that's perfectly fine as well. Let me know and I can update the PR.

paninaro commented 3 years ago

Could also combine the two ideas to form a version string like the following:

2021.08.25-0b9a44a

madMAx43v3r commented 3 years ago

I'm not a fan of the date, because you'd have to update it on every commit right?

madMAx43v3r commented 3 years ago

How about x.y.z-hash ?

paninaro commented 3 years ago

How about x.y.z-hash ?

This would be my preference as well. What values for x.y.z can we start with? The stotiks releases are at 0.1.6 I believe.

madMAx43v3r commented 3 years ago

Let's make it 1.1.6 then?