SAM Documentation Release Procedures

for cutting sam_doc, sam_data_browsing, sam_talks

When cutting sam_doc, sam_data_browsing, or sam_talks, follow these simple directions. They are somewhat similar to the General SAM Version Cutting instructions, but different enough that you should use these steps.

Prior to cutting sam_doc, you must make certain that you have cut versions of sam_talks and sam_data_browsing that are compatible with your version of sam_doc. You can cut versions of sam_talks and sam_data_browsing using these same instructions, and just substitute sam_talks or sam_data_browsing for sam_doc.

Tables files for each of the sam documentation products are now simple table files, with no product dependencies required. However, your web server must have the proper RewriteRule in effect to allow support for the old sam_doc web site configuration of sam/talks and sam/dataBrowsing to now point to sam_talks and sam_data_browsing, respectively. The web servers d0db-dev.fnal.gov, d0db-int.fnal.gov, and d0db-prd.fnal.gov are all pre-configured with this RewriteRule, so there is no work required for those.

The actual steps required to cut a version of one of the sam documentation products are outlined below. The commands shown from d0ora3 can be performed from any machine from which you can access cvs and are known to upd as a product maintainer. And it may seem obvious, but remember to change vX_Y below with the version number you are cutting.

Note that we are NOT ups declaring these products on d0ora3 anymore! The hourly sam cron jobs keeps the devel web site up-to-date, so ups products for these on d0ora3 are useless. Please do NOT add to our baggage by declaring them on d0ora3.

        First, checkout the latest changes from CVS and tag the version.
        Make sure your group is products and umask is 002.

        <d0ora3> cd /fnal/ups/prd/sam_doc  /* Or elsewhere if you are not working on d0ora3. */
        <d0ora3> cvs co -P sam_doc    /* Use -P to Prune empty directories. */
        <d0ora3> mv sam_doc vX_Y
        <d0ora3> cd vX_Y
        <d0ora3> cvs tag vX_Y
        <d0ora3> upd addproduct -r $PWD -M ups -m sam_doc.table -f NULL -t sam_doc vX_Y
        /* Yes, we're just letting upd make the gzipped tar file for us! */

        Now, you have a tagged version in CVS and a new test version in upd.
        Next, deploy the version as test on d0ora1 as follows.

        <d0ora1> upd install sam_doc -t -G"-t"
        <d0ora1> setup -t sam_doc; cd $SAM_DOC_DIR/../..; rm test; ln -s vX_Y/NULL test
        /* We hope to remove the above line soon, but for now it's required. */
        Test the new sam_doc product on d0db-int.fnal.gov.

        Then, when ready, declare the version current in upd from d0ora3.
        It's required that you do it this way instead of declaring it
        current in the first place above.  Waiting until you've tested the
        products is always required prior to making them current!

        <d0ora3> upd modproduct -c -f NULL sam_doc vX_Y

        Finally, deploy the current version on d0ora1.
      
        <d0ora1> ups declare -c sam_doc vX_Y
        <d0ora1> setup sam_doc; cd $SAM_DOC_DIR/../..; rm current; ln -s vX_Y/NULL current
        /* We hope to remove the above line soon, but for now it's required. */