The Wayback Machine - https://web.archive.org/web/20201216173641/https://github.com/AcademySoftwareFoundation/OpenCue/issues/641
Skip to content

/ OpenCue

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

Jump to bottom

Fix CueGUI version number #641

Open
bcipriano opened this issue Mar 5, 2020 · 13 comments
Open

Fix CueGUI version number #641

bcipriano opened this issue Mar 5, 2020 · 13 comments
Assignees
@bcipriano
Labels
bug good first issue triaged
Projects
OpenCue Backlog

Comments

@bcipriano
Copy link
Collaborator

@bcipriano bcipriano commented Mar 5, 2020

Describe the bug
The version displayed in CueGUI is hardcoded:

OpenCue/cuegui/cuegui/Constants.py

Line 35 in 76a3b71

VERSION = "1.3.0"

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:

OpenCue/cuegui/setup.py

Line 23 in 76a3b71

os.path.join(cuegui_dir, 'VERSION'),

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
76a3b71
@bcipriano bcipriano added this to To do in OpenCue Backlog via automation Mar 5, 2020
@SarthakDandriyal
Copy link

@SarthakDandriyal SarthakDandriyal commented Mar 5, 2020

Hi @bcipriano I would like to work on this issue.
@bcipriano
Copy link
Collaborator Author

@bcipriano bcipriano commented Mar 5, 2020

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.
@nimeshvashistha
Copy link

@nimeshvashistha nimeshvashistha commented Mar 18, 2020

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

@SarthakDandriyal Are you still working on this issue?
@akshat0047
Copy link

@akshat0047 akshat0047 commented Mar 18, 2020

Hi @bcipriano I would like to take up this issue
@bcipriano
Copy link
Collaborator Author

@bcipriano bcipriano commented Mar 18, 2020

@SarthakDandriyal Please let me know by tomorrow if you plan to work on this still.
srbhss added a commit to srbhss/OpenCue that referenced this issue Mar 19, 2020
@srbhss
Version number pulled from version.in file to constant.py
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
526fd23 
issue AcademySoftwareFoundation#641 
Using os module pulled the version number from VERSION.in file.
Default value is set to 'UNKNOWN'.
@srbhss srbhss mentioned this issue Mar 19, 2020
Merged
@akshat0047
Copy link

@akshat0047 akshat0047 commented Mar 20, 2020

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

@srbhss srbhss commented Mar 20, 2020

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

@bcipriano bcipriano commented Mar 20, 2020

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
Copy link
Collaborator Author

@bcipriano bcipriano commented Mar 20, 2020

@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 bcipriano assigned srbhss and unassigned akshat0047 Mar 20, 2020
@bcipriano
Copy link
Collaborator Author

@bcipriano bcipriano commented Mar 20, 2020

@srbhss Now that this issue is yours, I'll review the PR you've sent.
@bcipriano
Copy link
Collaborator Author

@bcipriano bcipriano commented Apr 13, 2020

#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.
@vikram-atreya
Copy link

@vikram-atreya vikram-atreya commented Oct 9, 2020

@bcipriano Sir I would like to continue the work on this issue. Could you assign this to me please.
@bcipriano bcipriano assigned bcipriano and unassigned srbhss Oct 22, 2020
@bcipriano
Copy link
Collaborator Author

@bcipriano bcipriano commented Oct 22, 2020

@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!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug good first issue triaged
6 participants
@bcipriano @SarthakDandriyal @akshat0047 @nimeshvashistha @srbhss @vikram-atreya
You can’t perform that action at this time.