Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-1241

Add documentation about clearing bundle directory

        Details

        • Type: Documentation
        • Status: Closed (View Workflow)
        • Priority: Major
        • Resolution: Done
        • Affects Version/s: None
        • Fix Version/s: None
        • Labels:
          None

          Description

          When you build IGB, existing jar files in the repositories bundle directory are allowed to persist. This makes it difficult to test code changes. To be sure that the IGB build you are running reflects the code you currently have, clear all jar files before building.

          In top level of git repository:
          $ rm *.jar bundles/

          Then build the project
          in Netbeans: right click > clean and build
          in command line: mvn clean install

          If you don't know to clear the bundle directory, this causes a lot of problems in testing. This needs to be very clear in our documentation for developers, particularly in the class for new IGB developers.

            Attachments

              Activity

              Ascending order - Click to sort in descending order
              ieclabau Ivory Blakley (Inactive) created issue -
              ann.loraine Ann Loraine made changes -
              Field Original Value New Value
              Workflow Loraine Lab Workflow [ 17931 ] Fall 2019 Workflow Update [ 18843 ]
              ann.loraine Ann Loraine made changes -
              Workflow Fall 2019 Workflow Update [ 18843 ] Revised Fall 2019 Workflow Update [ 20968 ]
              Status Open [ 1 ] To-Do [ 10305 ]
              nfreese Nowlan Freese made changes -
              Sprint Spring 2 2021 Apr 5 - Apr 16 [ 118 ]
              nfreese Nowlan Freese made changes -
              Assignee Ann Loraine [ aloraine ]
              ann.loraine Ann Loraine made changes -
              Epic Link IGBF-1531 [ 17617 ]
              ann.loraine Ann Loraine made changes -
              Story Points 1
              rweidenh Logan Weidenhammer (Inactive) made changes -
              Assignee Rachel Weidenhammer [ rweidenh ]
              rweidenh Logan Weidenhammer (Inactive) made changes -
              Status To-Do [ 10305 ] In Progress [ 3 ]
              Hide
              Permalink
              rweidenh Logan Weidenhammer (Inactive) added a comment - - edited

              On the Canvas class for new IGB developers, in the Functional Review section: https://canvas.instructure.com/courses/1164217/pages/understand-igb-development-workflow

              Text Added:

              NOTE:
              When you build IGB, existing jar files in the repositories bundle directory are allowed to persist.  
              This may effect any code changes you are trying to test.  
              To be sure that the IGB build you are running reflects the code you currently have, clear all jar files in the bundles directory before building.

              To do this in a development environment:
              In top level of git repository:
              $ rm *.jar bundles/
              Then build the project
              in Netbeans: right click > clean and build
              in command line: mvn clean install

              or

              To do this in IGB:
              Reset preferences to default by: Launching IGB > Preferences > Other Options > Reset Preferences to Default
              Delete the IGB folder in AppData located at C:\Users\<user>\AppData\Roaming\IGB (sometimes the AppData folder is "hidden", Go to the View tab in File Explorer and check the Hidden Items checkbox)
              Go to the IGB installation folder (defaults to C:\Program Files\IGB ) and run the uninstall.exe application there.
              Now when you reinstall IGB, it should act as if IGB has never been installed.

              Show
              rweidenh Logan Weidenhammer (Inactive) added a comment - - edited On the Canvas class for new IGB developers, in the Functional Review section: https://canvas.instructure.com/courses/1164217/pages/understand-igb-development-workflow Text Added: NOTE: When you build IGB, existing jar files in the repositories bundle directory are allowed to persist.   This may effect any code changes you are trying to test.   To be sure that the IGB build you are running reflects the code you currently have, clear all jar files in the bundles directory before building. To do this in a development environment: In top level of git repository: $ rm *.jar bundles/ Then build the project in Netbeans: right click > clean and build in command line: mvn clean install or To do this in IGB: Reset preferences to default by: Launching IGB > Preferences > Other Options > Reset Preferences to Default Delete the IGB folder in AppData located at C:\Users\<user>\AppData\Roaming\IGB (sometimes the AppData folder is "hidden", Go to the View tab in File Explorer and check the Hidden Items checkbox) Go to the IGB installation folder (defaults to C:\Program Files\IGB ) and run the uninstall.exe application there. Now when you reinstall IGB, it should act as if IGB has never been installed.
              Hide
              Permalink
              rweidenh Logan Weidenhammer (Inactive) added a comment -

              Added the same text to new "Testing your code changes" section in the IGB developers guide: https://wiki.transvar.org/display/igbdevelopers/Developing+Integrated+Genome+Browser

              Show
              rweidenh Logan Weidenhammer (Inactive) added a comment - Added the same text to new "Testing your code changes" section in the IGB developers guide: https://wiki.transvar.org/display/igbdevelopers/Developing+Integrated+Genome+Browser
              rweidenh Logan Weidenhammer (Inactive) made changes -
              Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
              rweidenh Logan Weidenhammer (Inactive) made changes -
              Assignee Rachel Weidenhammer [ rweidenh ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Assignee Irvin Naylor [ inaylor ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Resolution Done [ 10000 ]
              Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
              inaylor Irvin Naylor (Inactive) made changes -
              Assignee Irvin Naylor [ inaylor ]
              Hide
              Permalink
              inaylor Irvin Naylor (Inactive) added a comment -

              Everything looks good to me! Moved to closed.

              Show
              inaylor Irvin Naylor (Inactive) added a comment - Everything looks good to me! Moved to closed.
              rweidenh Logan Weidenhammer (Inactive) made changes -
              Assignee Rachel Weidenhammer [ rweidenh ]

                People

                • Assignee:
                  rweidenh Logan Weidenhammer (Inactive)
                  Reporter:
                  ieclabau Ivory Blakley (Inactive)
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: