Next: , Previous: Editing, Up: Top   [Contents][Index]

7 Making a distribution

This section provides the instructions for publishing a Daikon distribution, a.k.a. making a release. If you only want to create the daikon.tar or daikon.tar.gz file in your own directory, then simply run make daikon.tar or make daikon.tar.gz.

Official releases have even version numbers (e.g., 4.6.4) and intermediate work has odd version numbers (e.g., 4.7.3). This means as you prepare for a release the current version number is probably odd. It will be updated as one of the steps in the release process. After making the distribution, one of the final steps is to increment the version number again to prepare for subsequent development. This system has the useful side effect of allowing the build and test process to be repeated to fix a problem without having to worry about updating or resetting the version number. Another advantage is to reinforce, to people who are working from the version control repository, that they are not using the released version, because the version numbers differ.

The Daikon distribution site is located at http://plse.cs.washington.edu/daikon/ and is served from the UW CSE file system at /cse/web/research/plse/daikon. In order to be able to write to the distribution site, your CSE user id must be a member of the ‘plse_www’ Unix group.

For each of the major steps below, an approximate elapsed time is listed. These timings are up to date as of December 2015. They were measured on a quad x86-64 based machine at 3.4GHz with 16GB of memory (buffalo.cs.washington.edu). Barring any difficulties, the entire process will take at least two hours — but could be much more depending on the number of different platforms on which you test the release.

Each of the steps below assumes that you are using the Bash shell.


Next: , Up: Distribution   [Contents][Index]

7.1 Directory layout requirements


Next: , Previous: Directory layout requirements, Up: Distribution   [Contents][Index]

7.2 Distribution setup instructions

The default version of the Java JDK on the majority of the CSE machines is now JDK 8. However, for the time being, we wish to continue to distribute JDK 7 .class files as part of our distribution process; the intention is to maximize compatibility with our existing code base. Thus, all of our Makefiles invoke ‘javac’ with ‘-source 7 -target 7’ to ensure this is the case. In addition, we wish to release Checker Framework enabled .class files. You should install the latest version of the Checker Framework tools from https://checkerframework.org and set the CHECKERFRAMEWORK environment variable as described in the Installation section of the manual.

The recommended setup for the distribution process:

This should fulfill most of the directory layout requirements noted above.


Next: , Previous: Distribution setup instructions, Up: Distribution   [Contents][Index]

7.3 Getting the latest version of dependencies

Update the Daikon source files to their most recent version.

set -o pipefail
(cd $DAIKONDIR && git pull && git log --branches --not --remotes && git status)
(cd $DAIKONDIR/../fjalar && git pull && git log --branches --not --remotes && git status)

Each of the two commands should print exactly 4 lines:

Already up-to-date.
On branch master
Your branch is up-to-date with 'origin/master'.
nothing to commit, working directory clean

[Time: moments]

The Fjalar tool set (primarily, Kvasir) is built upon, or uses pieces from, two open source projects. The home page for the Valgrind instrumentation framework is http://www.valgrind.org. The home page for the GNU Binutils (a collection of binary tools, of which Kvasir uses only readelf) is http://www.gnu.org/software/binutils/.

File $DAIKONDIR/fjalar/valgrind/REVISION indicates the version of these tools that Kvasir uses. You can determine whether a newer version of these tools is available by comparing the REVISION file to http://valgrind.org/downloads/current.html and http://ftp.gnu.org/gnu/binutils/?C=M;O=D. If so, you should update the Fjalar source tree as soon as practical. For details, see the separate document “Merging newer versions of Valgrind into Fjalar”, which appears in the fjalar repository.


Next: , Previous: Updating dependencies, Up: Distribution   [Contents][Index]

7.4 The day before the release

Do these steps the day before the release, so that tests have time to complete overnight.

TODO: it would be good to build the staging release the day before, too, so that links can be fixed the day before the release or at least very early in the process.


Previous: The day before the release, Up: Distribution   [Contents][Index]

7.5 Steps for making the distribution

Use the Checker Framework Java compiler for the release process. Make sure the CHECKERFRAMEWORK environment variable is properly set.

  1. Verify that Daikon passes its tests, under both JDK 7 and JDK 8.

    For Travis CI, all of the following jobs should be green:

    If any of the jobs is not passing, then correct the problem and wait for the jobs to complete and pass. The delay to wait for this to happen is a reason that you should avoid making changes to Daikon on the release day. Instead, you should make changes the day before to permit the continuous integration jobs to run overnight.

  2. Do a very clean rebuild of everything.
    cd $DAIKONDIR
    make very-clean
    make rebuild-everything
    

    [Time: 20 min]

  3. Once you have successfully reached this point, you are ready to make a release candidate and begin testing it. The following command will verify that doc/CHANGES is up-to-date and then list any uncommitted files.
    make check-repo
    

    The result of the command above should be:

    On branch master
    Your branch is up-to-date with 'origin/master'.
    nothing to commit (use -u to show untracked files)
    

    If the command output lists any files, they need to be committed to the repository and pushed now. In that case, you will need to return to step 1 and wait for the Travis jobs to complete.

    [Time: moments]

  4. Set the version number in file $DAIKONDIR/doc/VERSION to an even number. You may do this manually, or if the revision number just needs to be incremented by 1 (to go from odd to even) you may use:
    make update-dist-version-file
    

    Note that if a new feature has been added, or if some change has made the current version incompatible from the previous release (such a change in the dtrace file format or revised names for tool options), then you should manually edit the VERSION file to increment the minor version number and reset the revision number to zero.

    Optionally, override the distribution date (default: today) by redefining the environment variable TODAY:

    export TODAY='November 1, 2013'
    

    Now, update the appropriate files with the date and version number of the release and commit these changes back to the repository:

    make update-and-commit-version
    

    [Time: moments]

  5. It is important to build the release candidate from a clean enlistment. This is to ensure we are testing only the files intended for release and that those files are the same as a user would receive with a clone of the repository. This needs to be done in a separate, new Bash command shell. The following commands get a fresh clone of Daikon, set some environment variables and then build everything to be distributed and copy it to the temporary staging area (http://plse.cs.washington.edu/staging-daikon/).
    mkdir -p /tmp/$USER
    rm -rf /tmp/$USER/stage-daikon
    git clone --depth 3 https://github.com/codespecs/daikon /tmp/$USER/stage-daikon
    cd /tmp/$USER/stage-daikon
    export DAIKONDIR=`pwd`
    export JAVA_HOME=/homes/gws/markro/jdk8
    export CHECKERFRAMEWORK=<path to lastest version of Checker Framework tools>
    source scripts/daikon.bashrc
    make staging
    

    The final output of this command will be a list of files that were added/removed since the last release. If any of these differences is unexpected, then investigate. If any corrections are required, do so back in the main repository, commit the changes and then repeat this step.

    [Time: 23 min]

  6. Next, check the staging website to see if it has any broken document links.
    make check-for-broken-doc-links
    

    Review check.log and make corrections as appropriate.

    In some cases a "403 Forbidden" error is transient, due to the website being down. You can check such links by hand.

    If the URL is correct but cannot be checked (for example, because the website prohibits spiders or because the URL redirects to another URL but you prefer to keep the first URL in your document), then you may need to add lines to an appropriate part of file checklink-args.txt in https://github.com/plume-lib/checklink.

    In most cases (and for most 404 errors), you should fix the document with the incorrect link. Here is a workflow that may be used to deal with broken links:

    Note that you must fix problems in the original repository, not in the drop directories. This means:

    If check.log contains an error message of the form:

    List of broken links and other issues:
    http://plse.cs.washington.edu/daikon/download/doc/developer/Requirements-for-compiling-Kvasir.html
      Line: 185
      Code: 200 OK
     To do: Some of the links to this resource point to broken URI fragments
            (such as index.html#fragment).
    The following fragments need to be fixed:
            Requirements-for-compiling-Kvasir       Line: 185
    

    This is probably caused by the way makeinfo deals with chapter splits via indirect references through stub files. Two suppress-fragment entries in checklink-args.txt in https://github.com/plume-lib/checklink are required. For the example above, these would be:

    --suppress-fragment http://plse.cs.washington.edu/daikon/download/doc/developer/Requirements-for-compiling-Kvasir.html#Requirements-for-compiling-Kvasir
    --suppress-fragment http://plse.cs.washington.edu/staging-daikon/download/doc/developer/Requirements-for-compiling-Kvasir.html#Requirements-for-compiling-Kvasir
    

    [Time: 8 min]

  7. Test the staged distribution on a 64-bit Fedora machine. Since the machine you are using to build the release is probably such a machine, you may simply run the command below. Success is indicated by invariant output being written to the screen.
    make test-staged-dist
    

    [Time: 1 min]

  8. Test the distribution on Ubuntu and MacOSX machines. Run the following commands:
    NEW_VERSION=`cat doc/VERSION`
    $PLUMEBIN/trigger-travis.sh codespecs test-daikon-staging `cat ~/private/.travis-access-token` \
      "Test staging distribution for release ${NEW_VERSION}"
    $PLUMEBIN/trigger-travis.sh codespecs test-daikon-staging-macosx `cat ~/private/.travis-access-token` \
      "Test staging distribution for release ${NEW_VERSION}"
    

    and then wait until the following two URLs indicate success:
    https://travis-ci.org/codespecs/test-daikon-staging
    https://travis-ci.org/codespecs/test-daikon-staging-macosx

    If there is a problem, fix it and start over.

    [Time: 15 min]

    Note that sometimes Travis has trouble starting MacOSX jobs. You may wish to log on to a MacOSX machine (with the development tools installed) and run the tests manually. The example below shows the commands required to do this. The output should show a number of lines beginning with "Processed" as dcomp_rt.jar is being built. Next it should indicate that Kvasir was not built because this is not a Linux platform. Then execution will continue with a test that runs Chicory/Daikon on the StackAr example. Success is indicated by invariant output being written to the screen.

    export JAVA_HOME=$(/usr/libexec/java_home)
    mkdir -p ~/tmp
    cd ~/tmp
    curl --fail -O https://raw.githubusercontent.com/codespecs/daikon/master/scripts/test-distribution.sh
    export DAIKONBASEURL=http://plse.cs.washington.edu/staging-daikon
    sh test-distribution.sh
    

    [Time: 4 min]

  9. Test the distribution on a Windows machine with Cygwin installed, as a guest user (or at least one without environment variables such as $DAIKONDIR defined!).

    The output from the the commands below should show that dcomp_rt.jar is being built. Next it should indicate that Kvasir was not built because this is not a Linux platform. Then execution will continue with a test that runs Chicory/Daikon on the StackAr example. Success is indicated by invariant output being written to the screen.

    export JAVA_HOME="/cygdrive/c/Program\\\ Files/Java/jdk1.7.0_45"
    export DAIKONBASEURL=http://plse.cs.washington.edu/staging-daikon
    mkdir -p ~/tmp
    cd ~/tmp
    curl --fail -O https://raw.githubusercontent.com/codespecs/daikon/master/scripts/test-distribution.sh
    sh test-distribution.sh
    

    [Time: 10 min]

  10. Once you have successfully reached this point, you have a valid release candidate and are ready to make the actual release. Caution: If somewhere above you made a change to correct a problem you should have restarted the release process.

    At this point we are done building and testing the release candidate and you should exit the Bash command shell created in step 5 and return to your original Bash shell.

  11. Update the website by deleting the current release and then making the staged version the (new) current release.
    cd $DAIKONDIR
    make staging-to-www
    

    [Time: 1 min]

  12. Add a version label to the repository:
    cd $DAIKONDIR
    DAIKONVERSION=`cat $DAIKONDIR/doc/VERSION | xargs echo -n`
    git tag -a v$DAIKONVERSION -m $DAIKONVERSION
    git push --tags
    cd fjalar
    git tag -a v$DAIKONVERSION -m $DAIKONVERSION
    git push --tags
    

    [Time: moments]

  13. At this point the distribution has been completed. Bump the version number to an odd value for continuing development.
    cd $DAIKONDIR
    export -n TODAY
    make update-dist-version-file
    make update-doc-dist-date-and-version
    

    [Time: moments]

  14. Verify these changes by doing product builds (no need to clean first) and running a short verification test.
    cd $DAIKONDIR
    make rebuild-everything quick-test
    

    Success is indicated by invariant output being written to the screen.

    [Time: 5 min]

  15. Commit changes back to the repository:
    cd $DAIKONDIR
    git commit -a -m "Bump version number for ongoing development."
    git push
    cd fjalar
    git commit -a -m "Bump version number for ongoing development."
    git push
    

    [Time: moments]

  16. Send mail to the ‘daikon-announce’ mailing list. Use the suggested template below, replacing <version number> with the actual number of the release.
    <to:>  daikon-announce@googlegroups.com
    <subject:>  Daikon version <version number> has been released
    
    Daikon version <version number> is now available.
    
    Please see the entry from the doc/CHANGES file that appears below for more details.
    
    You can download the latest version of Daikon at:
    http://plse.cs.washington.edu/daikon/download/
    
      <your name>
    
    <a copy of the current entry from the doc/CHANGES file, with
    paragraphs refilled (remove unnecessary line breaks that trim lines
    to 80 columns for the CHANGES file but aren't desirable in email)>
    

    Note that if you use Microsoft Outlook 2010 or 2013 as your mailer, by default it will insert hard breaks in your outgoing message. See https://blog.techhit.com/551102-how-to-prevent-outlook-from-adding-line-breaks-to-sent-plain-text-messages for a work around. You must quit and restart Outlook to activate the change.


Previous: The day before the release, Up: Distribution   [Contents][Index]