1 arta  1.1 Art's suggested release recipe:
  2           

  3 arta  1.8 1. Notify users (jsoc_dev@sun.stanford.edu) that a new release will be
  4           built.  Allow users time to submit changes they want in the new
  5           release.  This includes changes made by the CM that have not been
  6           committed.  
  7           
  8           2. From a cluster-node (eg., n00), perform a clean sync to
  9           head as a non-Production user (cvs checkout -r HEAD JSOC).  The -r rev
 10           option is sticky, which means that if you used -r Ver_3-2 on a
 11           previous checkout, that "cvs checkout JSOC" will check out Ver_3-2.
 12           Use "-r HEAD" to force the use of the head revision. 
 13           
 14           3.Update $JSOCROOT/base/jsoc_version.h to the latest release version
 15           and build again (make clean, make universe).  The version macros
 16           should be of the form:

 17 arta  1.1 
 18           #define jsoc_version "V3R5"
 19           #define jsoc_vers_num (305)
 20           

 21 arta  1.9 4. From the machine used in step 2, commit $JSOCROOT/base/jsoc_version.h.

 22 arta  1.8 
 23           5. Add a new file, JSOC/CM/V<MAJ>.<MIN>/release.notes. This has the
 24           release notes (see below).  Commit.
 25           
 26           6. From the machine used in step 2, create a tag for the new release.

 27 arta  1.10   a. cd $JSOCROOT
 28              b. cvs tag -c Ver_<MAJ>-<MIN> . (Replace <MAJ>
 29            with the major version number and <MIN> with the minor version number.)
 30              c. cvs tag -d Ver_LATEST .
 31              d. cvs tag -c Ver_LATEST .

 32 arta  1.8  
 33            7. The NetDRMS release version number should also be incremented and

 34 arta  1.10 tagged:
 35              a. cd /tmp
 36              b. cvs checkout -r Ver_<MAJ>-<MIN> CORE 
 37              c. cvs checkout NETDRMSONLY (head version of netdrms-only files)
 38              d. cd JSOC
 39              e. cvs tag -c NetDRMS_Ver_<MAJ>-<MIN> .
 40              f. cvs tag -d Ver_LATEST .
 41              g. cvs tag -c Ver_LATEST .

 42 arta  1.8  

 43 arta  1.10 8. Now you must build all release executables with the release jsoc

 44 arta  1.8  version numbers in place ("V3R5" and "305" in this example). Ensure
 45            that the tag was successfully created and create actual release
 46            binaries (not just the binaries in your sandbox).  Login as the 'jsoc'
 47            user, cd to /home/jsoc/cvs, and do "cvs checkout -r Ver_<MAJ>-<MIN>
 48            JSOC" and build on all machines supported.  
 49            

 50 arta  1.9  9. Once again, edit $JSOCROOT/base/jsoc_version.h.  The

 51 arta  1.8  version macros should be of the form:

 52 arta  1.1  
 53            #define jsoc_version "V3R5X"
 54            #define jsoc_vers_num (-305)
 55            
 56            The "X" and "-" denote that binaries were created from non-release code.

 57 arta  1.7  

 58 arta  1.8  10. From the machine used in step 9, commit

 59 arta  1.9  $JSOCROOT/base/jsoc_version.h.  You might have to run "cvs
 60            update -A base/jsoc_version.h" to clear the sticky flag created

 61 arta  1.8  when you first sync'd in step 2 (if you used the "-r" flag).
 62            
 63            11. Send instructions for using the new release to users.

 64 arta  1.1  
 65            ================================================================================
 66            Example New Release Instructions
 67            
 68            
 69                                   Release Notes JSOC V3.8         12Sep2007
 70                                   -----------------------         ---------
 71            
 72            A release is a set of files, each having a specific version.  And a release typcially
 73            has a version number because over time you have newer and newer releases of the 
 74            same product.  For example, a hypothetical 1.3 release may contain fileA#1.8, 
 75            fileB#1.2, fileC#2.2 and a 1.4 release may contain fileA#2.5, fileB#2.1, fileC#2.9. 
 76            JSOC releases are similarly versioned and contain a set of such files.  JSOC release
 77            code is guaranteed to compile on cluster nodes (eg., n00, n02).  The resulting binaries
 78            have been minimally tested.  At the time of the creation of the release, the
 79            release versions of each file will be the most recent.  But as time passes, newer versions 
 80            of some files will be made, and there is no guarantee that these changes will
 81            not destabilize JSOC (ie., they may cause JSOC to no longer compile or execute
 82            properly).  
 83            
 84            There are several ways to use this release.  If you wish to simply use pre-built
 85 arta  1.1  binaries, you can simply use the production binaries, which are located at 

 86 arta  1.3  /home/production/cvs/JSOC.  Every time a release is created, the binaries in

 87 arta  1.1  this location get updated.  Only the production user can update these binaries.

 88 arta  1.3  So, you could run /home/production/cvs/JSOC/bin/linux_x86_64/show_keys, for example.

 89 arta  1.1  If instead you want to work with stable source files, then you must have a sandbox,
 90            which is a local copy (in your home directory) of the files in the cvs depot.  
 91            You would probably want to work with a sandbox if you plan on making eventual 
 92            changes to the depot files.  Changes you make to your sandbox files are not visible 
 93            to other users until you "commit" those changes back to the cvs depot.  Please see
 94            "If You Don't Have a Sandbox" below for more information on how to create a sandbox.  

 95 arta  1.3  There is also a "working" release which resides in in /home/jsoc/cvs/JSOC.  New 

 96 arta  1.1  files may be placed here and existing files may be edited for common use before the 
 97            next official release.  Each time a release gets created, the source and binaries of 
 98            the working release get updated.  WARNING: the files you see here may not be stable 
 99            since by the time you see them, another user may have edited them. Only the production 
100            release is guaranteed to be stable and unchanged between releases.
101            

102 arta  1.4  Obtaining the Release
103            ---------------------
104            To update your working directory to this release, or to check-out this release anew, 
105            please visit http://jsoc.stanford.edu/jsocwiki/CvsInit. Please keep in mind that
106            users may have modified files since the release was created, so use of the 
107            scripts documented in the web page may result in a working directory whose
108            content is not identical to the release.  If updating, you can supply 
109            the flag "-R" to the jsoc_update.csh and jsoc_sync.csh scripts to download the
110            latest release.  This will ensure that your working directory has the exact, latest
111            release versions of the files (eg., jsoc_sync.csh -R). If checking-out, 
112            you can supply the argument "-r Ver_LATEST" to the "cvs checkout" command
113            to achieve the analogous result, but for a fresh checkout.  WARNING: if you use 
114            the "-R" or "-r" flags, please use only jsoc_update.csh or jsoc_sync.csh to update 
115            your sources thereafter.  Use of "-R" or "-r Ver_LATEST" will result in a cvs
116            "sticky flag" being set.  jsoc_update.csh and jsoc_sync.csh clear this sticky flag.

117 arta  1.1  
118            Additional Info
119            ---------------
120            If you are unfamiliar with the use of cvs see the file:

121 arta  1.3  JSOC/CM/working_with_sandbox.txt.

122 arta  1.1  
123            There's a linux4 cvs gui at xim:/usr/bin/lincvs
124            Also on our jsoc web page:
125            

126 arta  1.3  http://jsoc.stanford.edu/cvs/JSOC/

127 arta  1.1  
128            Use the Apache cvs gui to see the diffs. For example, go to

129 arta  1.2  http://jsoc.stanford.edu/cvs/JSOC/base/drms/

130 arta  1.1  and click on the name in the File column and then click on
131            "diffs to previous #" to see the diffs.
132            
133            End Example New Release Instructions
134            ================================================================================
135            
136            --Art Amezcua 9/12/2007
137            
138            
139            
140            

141 arta  1.3  					/home/jim/cvs/JSOC/CM/release.howto

142 arta  1.1  

143 arta  1.2  Make sure the cvs/JSOC/base/jsoc_version.h is updated.

144 arta  1.1  
145            A release is done from a sandbox. Get the production user sandbox to work:
146            

147 arta  1.3  > cd /home/production/cvs/JSOC

148 arta  1.1  

149 arta  1.3  d00:/home/production/cvs/JSOC>  $JSOCROOT/jsoc_update.csh

150 arta  1.1  
151            Do a sanity check on the make log files:
152            $JSOCROOT/make_jsoc_linux_X86_64.log
153            #$JSOCROOT/make_jsoc_linux_ia64.log
154            $JSOCROOT/make_jsoc_linux_ia32.log
155            
156            
157            -----------------------------------------------------------------------------
158            When all the makes are ok, tag all the most recent revisions in the repository:
159            

160 arta  1.3  > cvs -d /home/cvsuser/cvsroot rtag -r HEAD Ver_1-0 JSOC

161 arta  1.1  
162            To remove this tag do:
163            

164 arta  1.3  > cvs -d /home/cvsuser/cvsroot rtag -d Ver_1-0 JSOC

165 arta  1.1  

166 arta  1.3  NOTE: Tell users about Phil's script cvs/JSOC/jsoc_update.csh  to do

167 arta  1.1  their release update.
168            
169            
170            
171            ***************OLD STUFF BELOW******************************************
172            -----------------------------------------------------------------------------
173            
174            Resync with the repository:
175            
176            > cvs update -APd >& cvsupdate.log
177            
178            Inspect cvsupdate.log for any "C " status.
179            
180                   C file
181                     A  conflict  was detected while trying to merge your changes to file
182                     with changes from the source repository.  file  (the  copy  in  your
183                     working  directory) is now the result of attempting to merge the two
184                     revisions; an unmodified copy of your file is also in  your  working
185                     directory, with the name .#file.revision where revision is the revi-
186                     sion that your modified file started from.  Resolve the conflict 
187            
188 arta  1.1  -----------------------------------------------------------------------------
189            Check for any files that have not been commited (not Status: Up-to-date):
190            
191            > cvsstatus	(NOTE: s/b an alias for $JSOCROOT/scripts/cvsstatus.pl)
192            
193            Determine if any modified files need to be committed or replaced with the
194            repository version before proceeding.
195            
196            -----------------------------------------------------------------------------
197            Get the all the makes to work:
198            > ssh production@lws               (and then again for d00 and n00(32bit))

199 arta  1.3  > cd /home/production/cvs/JSOC

200 arta  1.1  ####(OLD) > setenv ORACLE_HOME /u01/app/oracle/product/10.1.0/db_1
201            > ./configure -force  (for n00: ./configure -force -client)
202            (may have to do a make cleandep; make depend)
203            (ignore modification time in future msgs)
204            
205            > make clean
206            > make -j 4 >& make.log.lws        (run 4 jobs in parallel for speed)
207            
208            ############## ONLY HAD TO DO THIS THE FIRST TIME ############################
209            !!!!!!!!!!!!!!!!!Check that libsum, sumsapi, and sum dirs use gcc !!!!!!!!!!!
210            !!!!!!!!!!! Don't have to do this if gcc is already in the Makefile !!!!!!!!!
211            Now go to the dirs that need to have the gcc compile and edit Makefile:

212 arta  1.2  cd /home2/production/cvs/JSOC/base/
213            cd sums/libs/pg

214 arta  1.1  vi Makefile
215            ***ADD after the line:
216            include ../../make.mk
217            
218            ###Mod by JA after configure is run#########################
219            CC = gcc
220            CFLAGS = -std=gnu99 -g -Wall -O0 -Wno-comment -Wno-parentheses
221            
222            And then do
223            >make clean
224            >make
225            And do the same for cd ../sumsapi/ and cd ../sum/
226            ############## ONLY HAD TO DO THIS THE FIRST TIME ############################
227            
228            
229