IGB Developer's Guide
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 51 Next »

Version control

The IGB project uses git for version control. Previously, we used svn (subversion) and cvs before that. We migrated from an svn repository on SourceForge to a git repository on Bitbucket in 2014.

The main repository address is: https://bitbucket.org/lorainelab/integrated-genome-browser.

If you're developing the core IGB code base, you should make changes to the master branch. 

IGB versioning - major and minor releases

IGB uses semantic versioning, described in Semantic Versioning 2.0.

IGB releases have version names like 8.3.0 or 8.4.2, following the naming convention [M].[N].[P], where M, N, and P are integers.

In IGB, N is the major release number, M is the minor release number, and P is the micro or "bug fix" release number. (Bug fix releases are also called patches.)

All new minor and bug fix releases of IGB support all API methods supported in earlier versions with the same major release number. New releases that increment the minor or micro numbers may contain changes to the API, but these will maintain backwards-compatibility with all prior versions from the same major release. This means that new minor or bug fix releases can run any IGB App built against earlier versions from the same major release.

New major releases of IGB will contain so-called "contract breaking" changes to the IGB API. This means that a new release that increments the major number (e.g., releasing IGB N.0.0) may include changes to the API methods that affect IGB Apps built using the previous major release.

To ensure that users can run your App when a new major version is released, you should re-build your App using the latest IGB platform and release it in the usual way. However, if you are unable to release an update to your App, users will always be able to run it using older versions of IGB, which they can get from our files download page at Sourceforge.

Before making a major release, the IGB core development team contacts everyone we know of who is developing IGB Apps to alert them to upcoming changes in the API.

 

QuickLoad testing

The following git repository contains broken QuickLoad sites that are helpful for testing within IGB.

https://bitbucket.org/lorainelab/brokenquickloads

Genoviz SDK

IGB depends on the Genoviz Software Development Kit (Genoviz SDK) which is version-controlled in a separate repository at https://bitbucket.org/lorainelab/genoviz-sdk. When you build IGB, the compilation tool we use (maven) will obtain the latest copy of the genoviz compiled code (a "jar" file) and install it locally.

  • No labels