OLFSReleaseGuide

From OPeNDAP Documentation
Revision as of 19:39, 5 February 2016 by Jimg (talk | contribs) (Check in changes)

<< back to HowTo Guides

1 Overview

This document describes how to make releases of the OLFS.

For this document, $svn refers to the svn root, presumably "https://scm.opendap.org/svn".

About version numbers:

  • We use Hyrax <major>.<minor> version numbers for release branches.
  • We use <major>.<minor>.<revision> version numbers for the olfs code version.

New versions of a release (only the <revision> field in the version number is changed) should contain:

  • Bug fixes.
  • Updated tests.
  • Changes to production rules.

These changes should be made on the trunk and the merged to the release branch.

Since major development is only happening on development branches, very little on the trunk should change until a development branch is merged into the trunk. If new features are added or the code API changes there should be a new release made, which means make a new release branch.

This page is based on the branching and merging guidelines found here.

2 Make sure the code is ready to release

Make sure that all of the developers working on the code have checked in their working copies of the trunk, and that all development branches whose functionality/features/codeBase are to included in the release have been merged to the trunk and committed.

2.1 Check out the OLFS code from the subversion trunk

In a new directory get a fresh copy of the trunk:

git clone https://github.com/opendap/olfs

2.2 Build the OLFS

In the checked out OLFS directory run the command:

% ant server

2.3 Run the tests

Updated Jan 26th 2016

The OLFS utilizes an autotools/automake/autotest test system. In order to to run the tests you must build and install the BES first. Then build and install the OLFS into a Tomcat instance and start that instance.

NB - Do NOT specify version numbers at this stage as the test baselines are set up for the default version number of Not.A.Release. Building with a non-default version number will cause at least 12 tests to fail.

Once you have the OLFS built, installed, and running, return to the olfs top level directory and run:

./configure
make check

This will run the tests in a traditional autotest test harness.

3 Determine OLFS Version Number

  1. Look in the NEWS and README files to determine the previous version number.
  2. Determine new version number by looking at the changes to the code (start by reviewing the ChangeLog file)
    • Versioning rules: What the MAJOR.MINOR.REVISION string means:
      • No interfaces changed, only implementations (good): ==> Increment REVISION.
      • Interfaces added, none removed (good): ==> Increment MINOR, set REVISION to 0.
      • Interfaces removed or changed (BAD, breaks upward compatibility): ==> Increment MAJOR, set MINOR and REVISION to 0.
  3. Remember the new version number so that it can be used to:
    • Update the release related files
    • Build the versioned software distribution bundles.

4 Edit the release related files

ChangeLog
Update the ChangeLog file using the script update_cl.sh which can be found in the svn-tools project. (e.g., ~/svn-tools/update_cl.sh ChangeLog). If you're making the first ChangeLog entries, then you'll need to create the ChangeLog file first. Then, to write the NEWS file, just read over the new ChangeLog entries and summarize.
README
Update version number.
Review content to make sure it's current.
NEWS
Add new version number and,
Summarize the new additions to the change log. There may be many checkins associated with new feature development. You can summarize those as "Added 'X' feature."
install.html
Update version number.
Review content to make sure it's current.

5 Check in changes

In the local copy of the OLFS trunk in which you updated the ChangeLog and other files:

git commit -a -m "olfs: Updating olfs version and release files to version 1.2.3"

Once this is done, use github to tag the code you just committed both with its version and the version of hyrax to which it belongs:

  1. Tag the release:
    • git tag -a version-<numbers> -m "Version <number>"
    • git push origin version-<numbers>
  2. If this is part of Hyrax, also tag this point in the master branch with the Hyrax release number:
    • git tag -a hyrax-<numbers> -m "Hyrax <number>"
    • git push origin hyrax-<numbers>
    • NB: Instead of tagging all of the modules, use the saved commit hashes that git tracks for submodules. This cuts down on the bookkeeping for releases and removes one source of error; recording the wrong version for one of the 17 or so modules. thus, there is no need to tag the code in the modules.

6 The release branch

Question for James
So what happens if the OLFS changes a lot on the trunk and the C++ code does not. Since release branch name is tied to a Hyrax version (ex: branch/olfs/release/hyrax-1.9) and the rule is to make a new release branch, what do? Do we abandon the hyrax release branch and make one named something like branch/olfs/release/olfs-1.10.2 ?? But then what if I also make changes to the OLFS to fix a bug for the hyrax-1.9 release and those are on the trunk too.
It's kind of like the two bodies of code don't progress in lock step.
Maybe the answer is that we don't merge development branches to the trunk until we are getting ready for a new release?
ndp 19:43, 12 September 2013 (PDT)

6.1 If the release branch does not exist then create it

Naming the release branch
Since every release of the OLFS is tied to a release of the Hyrax server we create OLFS release branches based the name of the Hyrax release with which they are associated.
svn cp -m "olfs: Creating OLFS release branch for hyrax-4.5" $svn/trunk/olfs $svn/branch/olfs/release/hyrax-4.5

6.2 Otherwise (the release branch exists) so merge the trunk to the branch

Checkout a copy of the release branch:

svn co $svn/branch/olfs/release/hyrax-4.5

In this new local copy of the release branch merge from the trunk like this:

svn merge $svn/trunk/olfs

You need to run this command from within a working copy and the changes are made to the working copy. You need to commit them to add them to the repository.

svn ci -m "olfs: Merged trunk to hyrax-4.5 release branch."

7 Tag the release

Determining the tag name
The tag should be named with the name and full version number of the Hyrax release.
  • If you created a new release branch (which is always named with the major.minor version) called hyrax-4.5 then the tag name will be hyrax-4.5.0
  • If you are releasing a new version of an existing release then the version field should be incremented by one from the previous version. So if the most recent tag was hyrax-4.5.6 then the new tag should be hyrax-4.5.7


7.1 Example: A new release branch was just created

And the new release branch is named hyrax-4.5 then add a 0 as the revision number for a tag name of hyrax-4.5.0

svn cp -m "olfs: Tagging OLFS release for hyrax-4.5.0" $svn/branch/olfs/release/hyrax-4.5 $svn/tags/olfs/hyrax-4.5.0

7.2 Example: Releasing a new revision an existing release

And the most recent release tag was hyrax-4.5.6 then add a increment the revision field for a tag name of hyrax-4.5.7

svn cp -m "olfs: Tagging OLFS release for hyrax-4.5.7" $svn/branch/olfs/release/hyrax-4.5 $svn/tags/olfs/hyrax-4.5.7

8 Build the versioned distribution bundles

Build the OLFS distribution files by running ant and providing both the Hyrax version and OLFS version.

First get a copy of the new tagged version from svn:

svn co $svn/tags/olfs/hyrax-4.5.0

In the local copy of the tag build the software:

ant -DOLFS_VERSION=1.2.3  -DHYRAX_VERSION=4.5.0 DISTRO

This will create the three compressed tar files for the release in the $olfs/build/dist directory.

olfs-1.2.3-doc.tgz
Contains the javadoc documentation for the release
olfs-1.2.3-src.tgz
Contains the source files for the release
olfs-1.2.3-webapp.tgz
Contains the instructions and .war file that will be used in the tomcat webapps directory.

Use GPG to detach sign each of these three files and you're ready to upload them to the website for distribution.

The OLFS has historically been published here: http://www.opendap.org/pub/olfs/