Versioning and upgrading

The current recommended production version is version 1.9.3.

Please see the change log for an overview of recent changes. For further details see the commit log:

• 1.8.1 to 1.9.3
• 1.7.1 to 1.8.1
• 1.6.0 to 1.7.1
• 1.5.3 to 1.6.0
• 1.4.0 to 1.5.3

Upgrading

The recommended upgrade path is from one minor version to the next, e.g. from version 1.4.x to 1.5.x. We do not recommend upgrading directly to higher versions, e.g. from version 1.4.x to 1.6.x, as this has not been tested.

Make sure that you are familiar with the changes that have been made before starting the upgrade. The change log will highlight any breaking changes and/or changes that will require manual intervention.

Start the upgrade by checking out a newer release from git:

git fetch origin
git checkout rel-1.9.3

Then upgrade dependencies and migrate the database:

bundle install
RAILS_ENV=production bundle exec rake db:migrate

Versioning

In the git repository releases are tagged rel-1.9.0, rel-1.9.1 etc. Each minor version is maintained on a separate branch which is called 1.8-branch, 1.9-branch etc.

The master branch is currently not ready for use.

Version milestones

These are planned major versions and associated milestones:

• 2.0: Update frameworks (Rails 5.0, modern JS libraries, Semantic UI)
• 3.0: Replace morphological representation and tokenisation tools (online POS tagging, probabilistic FSTs, lexically aware tokenisers)
• 4.0: Replace and unify annotation UIs (replace 'wizard' with a single-page app design)