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

          Hide
          rweidenh Rachel 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 Rachel 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
          rweidenh Rachel 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 Rachel 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
          Hide
          inaylor Irvin Naylor added a comment -

          Everything looks good to me! Moved to closed.

          Show
          inaylor Irvin Naylor added a comment - Everything looks good to me! Moved to closed.

            People

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

              Dates

              • Created:
                Updated:
                Resolved: