We maintain a set of maintenance releases for TextGridLab 2.0

Bug Fixing / Development

  1. Everything that needs to be fixed for a 2.0.x release needs a proper focused issue report in our Jira.
  2. Bug fixes should be applied to the trunk (nightly) code first.
  3. Each commit should be focused, and it SHOULD mention the relevant issue number (TG-1234) in its commit message
    1. If you accidently forget to include the issue number with a relevant commit, you MUST add a comment including the relevant revision number(s) of your commit(s) in the bug report
  4. You should increase the relevant artifact versions accordingly
  5. If your bug should be included in yet unreleased TextGridLab 2.0.n, include the relevant release in the bug reports fix for field

Preparing the Release Candidate

The 2.0.x train is maintained in the branch http://develop.sub.uni-goettingen.de/repos/textgrid/branches/releases/TextGridLab-2.0.x. There is an automatic build at http://dev.digital-humanities.de/ci/job/lab-2.0.x/. Example description for releasing TextGridLab 2.0.2.

  1. Checkout the branch
  2. Adjust the version number by running ./setversion.sh 2.0.2 in the branch directory. Requires xmlstarlet & performs the following edits:
    Adjust the version number in the following places (yes I know this sucks):
  3. Generate a list of bugs for the version to be released using the issue filter. Sort by date resolved, increasing
  4. For each bug:

Testing the Release Candidate

After the build with all included releases has finished, the RC should be tested

  1. Manual test against the features
  2. Functional test
  3. Test updates from previous lab version by
    1. downloading a clean copy of the previous version of the lab
    2. adding the update site, http://download.digital-humanities.de/updates/2.0.x/
    3. Check for updates or restart the lab
  4. Call for user tests

Release

When everything is tested we need to prepare the update site, upload the product zips and update the download website.

Prepare the Update Site

Prepare the Downloads

Download Website

  1. on textgridlab.org, cd into /var/www/download/2.0.2 and run the generate-lab-index.py script
  2. open the download page in the typo3 backend and
    1. paste the generate-lab-index.py output into the download table field in the hero block, replacing the existing content
    2. write a short release note in German and English into the corresponding field
    3. generate the changelog in Jira:
      1. go to the TextGrid project's Versions list
      2. click the version to release
      3. click the Release Notes link in the upper right
    4. paste the changelog into the corresponding field in typo3
    5. add last version to the list of archived versions

Jira

  1. Go to the Manage Versions page
  2. Release your version
  3. add a new version