Releasing Keshmesh

Perform the following steps to release a new version of Keshmesh.

Test

Run the tests in edu.illinois.keshmesh.detector.tests and make sure that they all pass.

Update site

1. Remove the following folders and files from edu.illinois.keshmesh.updatesite.
   • features/
   • plugins/
   • artifacts.jar
   • content.jar
   • logs.zip
2. Open edu.illinois.keshmesh.updatesite/site.xml in Eclipse.
3. Remove all the features listed in site.xml but not any categories.
4. Select the Keshmesh category in the Site Map. Then, press the Add Feature... button and select edu.illinois.keshmesh (1.0.0.qualifier) from the popped up dialog.
5. Press the button Build.

Publish

1. Install the new release of Keshmesh from the local file system into fresh instances of Eclipse to make sure that it installs successfully.
2. Check whether the update from an old version of Keshmesh to the new one works.
3. Copy the contents of the folder edu.illinois.keshmesh.updatesite into public_html/updates of the machine hosting the update site.
4. Repeat the first two steps for the remote update site.

Change Log

Update the change log at the root of the repository by the changes made in the new release. We usually have an issue devoted to releasing a new version of Keshmesh in which we keep track of the issues that are addressed in the new release. Use the release issue to update the change log. Then, close the release issue.

Tag

1. Be careful not to delete any build.xml files. For some reason, the build script of the update site sometimes deletes some of the other build scripts.

2. Commit the changes to the update site and change log. Use a commit message of the following form

    Released v<x>.<y>.<z>.<qualifier>
   
    This commit belongs to issue #<release-issue>.
   

In the above message, <x>, <y>, <z> and <qualifier> are parts of the version of the generated feature, and <release-issue> is the number of the issue devoted to this particular release of Keshmesh.

1. Push the commit to the remote repository.

2. Tag the commit containing the new release using the following command.

    git tag v<x>.<y>.<z>.<qualifier> <commit-sha>
   

Push the created tag to the remote repository using the following command.

    git push --tags