Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do something sensible with the Git Commit the in the About box #2175

Open
smk78 opened this issue Sep 1, 2022 · 6 comments
Open

Do something sensible with the Git Commit the in the About box #2175

smk78 opened this issue Sep 1, 2022 · 6 comments
Assignees
Labels
Housekeeping Tidying, renaming, formatting, minor refactoring, boring stuff in general
Milestone

Comments

@smk78
Copy link
Contributor

smk78 commented Sep 1, 2022

Copied from #2170

@butlerpd wrote:

the git commit in the "about" should probably be removed now that we are using versioning better? It was originally meant to be followed by the commit hash but only worked I think on one OS? and maybe only way way back at the dawn of time? As far as I know it has not worked for yonks and is thus useless -- unless somebody knows how to fix it.

@smk78 smk78 added the Housekeeping Tidying, renaming, formatting, minor refactoring, boring stuff in general label Sep 1, 2022
@smk78 smk78 added this to the SasView 5.1.0 milestone Sep 1, 2022
@lucas-wilkins lucas-wilkins self-assigned this Sep 14, 2022
@lucas-wilkins
Copy link
Contributor

Now in #2164

@lucas-wilkins
Copy link
Contributor

@smk78 Close this?

@smk78
Copy link
Contributor Author

smk78 commented Oct 31, 2022

In the sense that 'something sensible' has been done - the Git Commit has been removed from the About Box as far as I can see - I guess this can be closed. But out of curiosity, if one wanted to know the specific build of SasView that one was running, how would one tell?

@llimeht
Copy link
Contributor

llimeht commented Oct 31, 2022

I think that the git hash (and probably date) should appear in the version so that users and testers can answer that exact question: "which version did you test?".

I noticed @smk78 have that info the other day by specifying the artifact name the other day, which contains the hash. It would be better to have it in the About box too.

The date and git hash can easily be included in a pep440 version string. Tools like setuptools_scm and pbr exist to help with this. The version would be in the format:

{next_version}.dev{distance}+{scm letter}{revision hash}.dYYYYMMDD

A recent installer would then have the version 5.0.6.dev123+g987def3.d20221031. This tells us that's it's a dev version heading towards 5.0.6, it's 123 commits after 5.0.5 (ish), the git short hash is 987def3 and the date it was generated. When we get to alphas, betas etc then the strings become shorter.

@butlerpd
Copy link
Member

That sounds exactly like was what was originally intended for exactly the reasons @llimeht mentions, but "we" never seemed to manage to figure out how to get the githash into the about box... if somebody knows how to do this that would be wunderbar from my point of view!

@smk78
Copy link
Contributor Author

smk78 commented Oct 31, 2022

Seconded!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping Tidying, renaming, formatting, minor refactoring, boring stuff in general
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants