README-release.txt

   1 #!/bin/sh
   2 #
   3 # $Id$
   4 #
   5
   6 This documents what is done to create a gerbv release.  The releases now
   7 are done by branching the sources, fixing up the release version number
   8 in the branch and then tagging the release branch sources.  The motivation
   9 for a branch rather than a tag is to make it easier to deal with setting
  10 the release version number in the documentation, distfile, and the
  11 about dialog box.
  12
  13 Note that the gyrations with maintainer-clean and another build are to
  14 be sure that all the correct versions numbers end up in the files.
  15
  16 After following the steps below,
  17 upload the 'gerbv-$VERSION.tar.gz' file to the sourceforge file release system
  18
  19
  20 NOTE:  Due to the way that the regression tests work they will usually fail
  21 when run on a different machine (different CPU type for example) than what
  22 the test suite golden files were generated on.  To let the rest of 'distcheck'
  23 complete, use this:
  24
  25 setenv GERBV_MAGIC_TEST_SKIP yes
  26
  27 or under ksh/sh
  28
  29 GERBV_MAGIC_TEST_SKIP=yes
  30 export GERBV_MAGIC_TEST_SKIP
  31
  32 To make a gerbv release do the following:
  33
  34 =)      Review the BUGS file and make sure it is up to date.
  35
  36 =)      # make sure it builds and makes distfiles ok:
  37         ./autogen.sh
  38         ./configure --enable-maintainer-mode  --disable-update-desktop-database
  39         gmake maintainer-clean
  40         ./autogen.sh
  41         ./configure --disable-update-desktop-database
  42         gmake distcheck
  43
  44 =)      cvs ci
  45
  46 =)      Read the section in src/Makefile.am about the shared library versioning
  47         and make sure we have done the right thing.  Check in src/Makefile.am
  48         if needed.  This is critical.  The version *will* change with every release
  49         if *any* changes have been made to the sources for libgerbv.  src/Makefile.am
  50         has specific rules for how the versioning works.
  51
  52 =)      if there were any new developers added then update the
  53         ./utils/umap file.
  54
  55 =)      update the ChangeLog with 'cvs2cl.pl'.
  56         ./utils/cvs2cl.pl -U ./utils/umap
  57
  58 =)      update the NEWS file with some sort of release notes.
  59         I typically try to condense what I see in ChangeLog
  60         Check in changes to  NEWS and ChangeLog
  61
  62 =)      if this is a major release, then tag and branch:
  63
  64         1. Tag the base of the release branch
  65                 cvs tag gerbv-2-3-base
  66
  67         2. Create the release branch
  68                 cvs tag -R -b -r gerbv-2-3-base gerbv-2-3
  69
  70         3. On the trunk, update configure.ac to update the version.
  71            The rules for versioning is that we append uppercase
  72            letters to the branch version.
  73
  74                 for example 2.3A after creating the gerbv-2-3 branch
  75                 cvs update -PdA
  76                 vi configure.ac
  77                 cvs ci configure.ac
  78
  79         4. On the release branch, update configure.ac to update the
  80            version.  On a new branch, add a 0RC1 to the teeny number.
  81
  82                 for example 2.3.0RC1.
  83                 cvs update -PdA -r gerbv-2-3
  84                 vi configure.ac
  85                 cvs ci configure.ac
  86
  87         4a.Ask users to test the branch.
  88
  89         5. When the release branch is ready to go,  update configure.ac to
  90            set the final release version.  The first version from a
  91            branch has 0 for the teeny version.  For example, 2.3.0.
  92            Next tag the release.
  93                 cvs update -PdA -r gerbv-2-3
  94                 vi configure.ac
  95                 cvs ci configure.ac
  96                 cvs tag -R -r gerbv-2-3 gerbv-2-3-RELEASE
  97
  98            Update the version on the branch to 2.3.1RC1
  99                 cvs update -PdA -r gerbv-2-3
 100                 vi configure.ac
 101                 cvs ci configure.ac
 102
 103            Update to the tagged released sources and build tarballs
 104                 cvs update -PdA -r gerbv-2-3-RELEASE
 105                 ./autogen.sh
 106                 ./configure --enable-maintainer-mode --disable-update-desktop-database
 107                 gmake maintainer-clean
 108                 ./autogen.sh
 109                 ./configure --disable-update-desktop-database
 110                 gmake distcheck
 111
 112            If teeny version bumps are made for a bug fix, then the tag name
 113            should be gerbv-2-3-PATCH001 for gerbv-2.3.1,
 114            gerbv-2-3-PATCH002 for gerbv-2.3.2, etc.
 115
 116         7. Create checksums
 117
 118                 openssl md5 gerbv-2.3.0.tar.gz > gerbv-2.3.0.cksum
 119                 openssl rmd160 gerbv-2.3.0.tar.gz >> gerbv-2.3.0.cksum
 120                 openssl sha1 gerbv-2.3.0.tar.gz >> gerbv-2.3.0.cksum
 121
 122         8. Create a new file release for the package "gerbv" with a release name of
 123            "gerbv-2.3.0" (for gerbv-2.3.0).  Do this by logging into www.sourceforge.net
 124            and then navigating to
 125
 126            https://sourceforge.net/projects/gerbv  (you must be logged in to sourceforge)
 127
 128            Pick Admin->File Releases
 129
 130            Next to the "gerbv" package, click "Add Release"
 131
 132            In the "Step 1:  Edit Existing Release" section, paste in the section of the NEWS
 133            for this version.  Check the "Preserve my pre-formatted text" radio button and click
 134            "Submit/Refresh".
 135
 136            In the "Step 2: Add Files To This Release" section follow the "upload new files" link
 137            and then in the next page the "Web Upload" link.  You will have to log in to
 138            sourceforge again.
 139
 140            Upload the .tar.gz, .cksum, and if you built one, the windows installer.
 141
 142            Once you have completed the file uploads return to the edit releases page, check
 143            the radio buttons next to the uploaded files and click the "Add Files..." button.
 144
 145            In the "Step 3:  Edit Files in this Release" section, set the following:
 146                 For file types:
 147                         .tar.gz  -  any / source .gz
 148                         .cksum   -  Platform Independent / Other Source File
 149                         .exe     -  i386 / .exe (32-bit Windows)
 150
 151            You will have to click "update" for each file as you go.
 152
 153            In the "Step 4:  Email Release Notice" section, check the "I'm sure"
 154            radio button and click the "Send Notice" button.
 155
 156          9. Have a project admin go to the Admin->File Releases page and then
 157             follow the "Create/Edit Download page" to change the default download
 158             file to the new release.
 159
 160         10. Return to your regularly scheduled trunk development
 161
 162                 cvs update -PdA
 163
 164 =)      if this is a patch release (2.3.1 for example), then simply
 165         make desired changes to the branch:
 166
 167                 cvs update -PdA -r gerbv-2-3
 168                 # make changes
 169                 cvs ci
 170
 171         update the version for the release
 172                 vi configure.ac
 173                 cvs ci configure.ac
 174
 175         tag the release
 176                 cvs tag -R -r gerbv-2-3 gerbv-2-3-PATCH001
 177
 178         update the version on the branch to 2.3.2RC1
 179                 vi configure.ac
 180                 cvs ci configure.ac
 181
 182
 183         update to the tagged release sources and build tarballs
 184                 cvs update -PdA -r gerbv-2-3-PATCH001
 185                 ./autogen.sh
 186                 ./configure --enable-maintainer-mode --disable-update-desktop-database
 187                 gmake maintainer-clean
 188                 ./autogen.sh
 189                 ./configure --disable-update-desktop-database
 190                 gmake distcheck
 191
 192