Source Release for BES

From OPeNDAP Documentation
Revision as of 20:59, 29 February 2012 by Jimg (talk | contribs) (Created page with " Note that the old pages with the tables of version numbers are gone. Use the web pages themselves as documentation of what has or has not been built. For the current release, in...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Note that the old pages with the tables of version numbers are gone. Use the web pages themselves as documentation of what has or has not been built. For the current release, include grayed-out links to binaries we do plan to make but keep the grayed-out links in place for the current version only!

Here's how to make a source release:

  1. First, make sure that the source code you're using is on a branch, up-to-date (svn up) and that the software passes its tests and no outstanding tickets remain for the release milestone.
  2. Update the text documentation files and version numbers in the configuration files:
    1. 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 2005-12-20 ChangeLog). If you're making the first ChangeLog entries, then you'll need to create the ChangeLog file first. Here's a key tip: When you're making the commit log entries, always include the file name(s) of the affected files in your entry. Then to write the NEWS file, just read over the new ChangeLog entries and summarize. In the old days of CVS, the logs automatically included the names of the changed files, but subversion doesn't do that. A little discipline with those log entries will go a long way toward streamlining the release process!
    2. Make sure that the version number is set in the configure.ac and *.spec files! When the version number changes, reset the RPM release number to '1'. For several releases of the same version, increment the release number (the number after the dash in the RPM file name; we don't have release numbers for the tar files). I generally update the ChangeLog before updating the version numbers or NEWS, et c., files because the ChangeLog gives me a bird's eye view of what happened since the last release.
    3. libtool versioning rules:
     What is meant by the CURRENT[:REVISION[:AGE]] string passed to libtool. Note these are set using variables in the configure.ac script.
      1. No interfaces changed, only implementations (good): ==> Increment REVISION.
      2. Interfaces added, none removed (good): ==> Increment CURRENT, increment AGE, set REVISION to 0.
      3. Interfaces removed or changed (BAD, breaks upward compatibility): ==> Increment CURRENT, set AGE and REVISION to 0.
      4. So how do you know? For C++, build a file of the methods and their arguments using nm .libs/libdap.a | c++filt | grep ' T .*::' | sed 's@.* T \(.*\)@\1@' > libdap_funcs and compare that using diff on the previous release's library.
  2. Make sure that README, INSTALL and NEWS are updated (setting check-news in Makefile.am AUTOMAKE_OPTIONS will enforce this).
  1. Check in these changes.
  2. Tag the release:
    1. I use svn="http://scm.opendap.org/svn" in the following and in my shell.
    2. Use svn copy $svn/branch/<<package>> $svn/tags/<<package-name>>/<<release-number>>
  2. If this is the first release of <<package-name>>, you have to create the directory under tags using svn mkdir.
  1. Use svn's export command to get a copy of the code that does not have the .svn directories.
  2. Use automake's distcheck target (make distcheck) to make a source code tar file.
  3. Sign the tar file. See the help item on the main trac wiki page if you need instructions.
  4. Also check that the RPM and DMG targets are working. This is a lower priority item then the distcheck target because these targets seem pretty stable unless the packaging and distribution files are changed. If that is the case, these targets should be checked.
  5. Move the file to the web site for distribution.
  6. Update the web pages:
    1. Edit the package-specific page
  2. Edit the download index.html page
  2. Edit the whatsnew.html page

2. Add the edits from Whatsnew.html to the main index.html page under the News heading - the blocks can be copied verbatim and then the <name> element changed to a <href>. Follow the examples of the other entries. 2. edit the news.xml page to update the RSS news feed. One very useful tool is the RSS Feed Validator. 2. Edit the What's New section of the front page. 2. Check in those changes and ask someone else in the group to look them over. The more people from our group that look over prospective changes, the better. Then find someone who has write access to the web site and have them update the served pages. People who have write access are Yuan, James and Dan (at least, maybe others).

  1. Build binaries and upload to the web site as time permits. See Distributions.