Details
-
Type:
Task
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:0.25
-
Epic Link:
-
Sprint:Summer 3, Summer 5, Summer 6
Description
One of the reviewers of our 2024 BOSC abstract tried to build IGB but could not do it because they did not realize that they needed to use a JDK that includes JavaFX.
We need to make sure that the Readme makes this clear. In addition to stating that developers need to build IGB using JDK21 (our preferred JDK) we also need to tell them that the JDK they use needs to include JavaFX.
We could also recommend the JDK that we are using internally for building and deploying IGB.
I'm putting this in the current sprint so that we can get this done before I give the talk at the 2024 BOSC meeting in two weeks.
Attachments
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link | IGBF-1531 [ 17617 ] |
| Sprint | Summer 3 [ 197 ] |
| Summary | IGB Readme should state that a JDK with JavaFX is required to build IGB | IGB Readme should state that building IGB requires JavaFX |
| Assignee | Nowlan Freese [ nfreese ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Assignee | Nowlan Freese [ nfreese ] |
| Sprint | Summer 3 [ 197 ] | Summer 3, Summer 4 [ 197, 198 ] |
| Rank | Ranked higher |
| Status | In Progress [ 3 ] | To-Do [ 10305 ] |
| Sprint | Summer 3, Summer 4 [ 197, 198 ] | Summer 3 [ 197 ] |
| Sprint | Summer 3 [ 197 ] | Summer 3, Summer 5 [ 197, 199 ] |
| Rank | Ranked higher |
| Sprint | Summer 3, Summer 5 [ 197, 199 ] | Summer 3, Summer 5, Summer 6 [ 197, 199, 200 ] |
| Rank | Ranked higher |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
Reviewed the readme. Only two edits I would make:
- Change the YouTube link to the branded link: https://www.youtube.com/c/IntegratedGenomeBrowser
- Typo in the line: Visit the Branches section of your repsitory and right-click the branch you want to build.
I'm not sure how much specific information about the JDK we would need for someone to build IGB. I think an experienced developer would be able to figure it out based on the way it is written. A less experienced developer may need more information, but I'm not sure the readme would be the right place. Sravani did create a developers guide page on how to get IGB running in IntelliJ based on feedback from Dylan: https://wiki.bioviz.org/confluence/display/igbdevelopers/Setup+IntelliJ+for+IGB+development+with+Java+21
| Assignee | Ann Loraine [ aloraine ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Assignee | Ann Loraine [ aloraine ] | Nowlan Freese [ nfreese ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | Ready for Pull Request [ 10304 ] |
| Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
| Assignee | Nowlan Freese [ nfreese ] | Ann Loraine [ aloraine ] |
| Status | Pull Request Submitted [ 10101 ] | Reviewing Pull Request [ 10303 ] |
| Status | Reviewing Pull Request [ 10303 ] | Merged Needs Testing [ 10002 ] |
PR is merged. Ready for testing.
| Status | Merged Needs Testing [ 10002 ] | Post-merge Testing In Progress [ 10003 ] |
| Resolution | Done [ 10000 ] | |
| Status | Post-merge Testing In Progress [ 10003 ] | Closed [ 6 ] |
I re-wrote the IGB README.md file.
I would be grateful if someone could read it and offer feedback. Is it good enough?
See: