OpenCue icon indicating copy to clipboard operation
OpenCue copied to clipboard
verified publisher icon AcademySoftwareFoundation

Fix CueGUI version number

Open bcipriano opened this issue 5 years ago • 13 comments

Describe the bug The version displayed in CueGUI is hardcoded:

https://github.com/AcademySoftwareFoundation/OpenCue/blob/76a3b71bb646ebca4fb70ef6f438181161201da2/cuegui/cuegui/Constants.py#L35

This version number, when available, should be pulled from the VERSION/VERSION.in files, as they are in other places e.g. in setup.py:

https://github.com/AcademySoftwareFoundation/OpenCue/blob/76a3b71bb646ebca4fb70ef6f438181161201da2/cuegui/setup.py#L23

To Reproduce Steps to reproduce the behavior:

  1. Launch CueGUI
  2. The hardcoded version is displayed on the splash screen

Expected behavior If VERSION is available, that information should be displayed. If it's not, we should display some placeholder, or maybe some information about the current environment.

Screenshots Screen Shot 2020-03-04 at 6 32 05 PM

Version Number 76a3b71bb646ebca4fb70ef6f438181161201da2

bcipriano avatar Mar 05 '20 02:03 bcipriano

Hi @bcipriano I would like to work on this issue.

SarthakDandriyal avatar Mar 05 '20 02:03 SarthakDandriyal

Great!

To start -- if you download a released version of CueGUI you'll see that the VERSION file is already packaged with the download, and setup.py already makes use of this information. So probably that information just needs to be passed through to the main CueGUI code somehow.

It should work when you're a) running CueGUI directly from the code, i.e. python -m cuegui, and b) when you install CueGUI into your environment, i.e. running setup.py install and then cuegui.

bcipriano avatar Mar 05 '20 05:03 bcipriano

Hi @bcipriano I would like to work on this issue.

@SarthakDandriyal Are you still working on this issue?

nimeshvashistha avatar Mar 18 '20 01:03 nimeshvashistha

Hi @bcipriano I would like to take up this issue

akshat0047 avatar Mar 18 '20 17:03 akshat0047

@SarthakDandriyal Please let me know by tomorrow if you plan to work on this still.

bcipriano avatar Mar 18 '20 20:03 bcipriano

@bcipriano May I work on this or this or it's assigned to the PR owner

akshat0047 avatar Mar 20 '20 10:03 akshat0047

@bcipriano Sir please assign me to this issue , I would like to work on this issue.

srbhss avatar Mar 20 '20 14:03 srbhss

Ok, freeing this up to be worked on by someone else.

@nimeshvashistha was next in line but already found an issue to work on (#657).

@akshat0047 was next after that so will be the new assignee now.

(As mentioned on @srbhss's PR, we require that PRs have an issue attached, and that the PR author is assigned to the issue. This is laid out in our Contributing guide).

bcipriano avatar Mar 20 '20 19:03 bcipriano

@akshat0047 Actually, I realized that you already have an issue assigned (#163). Since others are searching for issues to work on I'll free this one up.

@srbhss is next in line for this one.

bcipriano avatar Mar 20 '20 22:03 bcipriano

@srbhss Now that this issue is yours, I'll review the PR you've sent.

bcipriano avatar Mar 20 '20 22:03 bcipriano

#662 lays the groundwork for this.

The next step is to make sure this works in the various environments CueGUI may be running in:

  • A code checkout of the repository, and run with python -m cuegui.
  • A code checkout of the repository, installed with setup.py install and run with cuegui.
  • A TAR release, installed withsetup.py install and run with cuegui.

This needs to keep in mind the location of the VERSION file. Depending on the deployment environment this file may be in a slightly different location, so #662's code may need to be tweaked. And in some cases VERSION may not exist at all yet! For example I don't believe we package VERSION with the release TAR at all right now; you may need to do that step first.

This should also consider what to do when VERSION doesn't exist, as in a full code checkout -- just use VERSION.in? Add a commit tag like in generate_version_number.sh? I haven't thought through this in detail yet but feel free to propose your own solution.

bcipriano avatar Apr 13 '20 22:04 bcipriano

@bcipriano Sir I would like to continue the work on this issue. Could you assign this to me please.

vikram-atreya avatar Oct 09 '20 05:10 vikram-atreya

@vikram-atreya Hi, sorry for the delay here. I've been working on this a bit as part of #785, and given that our methods of how we package CueGUI are about to change, I don't think it makes sense to work on at the moment. Better to let things settle out with the packaging first.

Lots of work to be done in our Backlog though! Thank you for your interest!

bcipriano avatar Oct 22 '20 21:10 bcipriano

Hi @bcipriano, has development on CueGUI packaging finalized to resume development on this?

n-jay avatar Nov 23 '22 18:11 n-jay

@bcipriano seems like this has been resolved with this function: https://github.com/AcademySoftwareFoundation/OpenCue/blob/2b7bfdddef7b7994a0dc5800142ab6a22f88d528/cuegui/cuegui/Constants.py#L82-L89

Although the 1.3.0 value is hard coded to be returned when the VERSION.in file isn't found.

n-jay avatar Mar 16 '23 05:03 n-jay

Yes, this is resolved now, I'll close it out.

We do still have that hardcoded 1.3.0 but I don't think it's really needed anymore. We could replace with unknown or development, something like that.

bcipriano avatar Apr 12 '23 18:04 bcipriano