README.snapshots

   1
   2 This documents what is done to create a pcb release.  The releases now
   3 are done by branching the sources, fixing up the release version number
   4 in the branch and then tagging the release branch sources.  The motivation
   5 for a branch rather than a tag is to make it easier to deal with setting
   6 the snapshot version number in the documentation, distfile, and the
   7 about dialog box.
   8
   9 NOTE:  Use the DISTCHECK_CONFIGURE_FLAGS to be able to run the distcheck
  10 target with lesstif as the built gui with
  11 DISTCHECK_CONFIGURE_FLAGS="--with-gui=lesstif" if you want to also verify
  12 that distcheck works with the lesstif HID.
  13
  14 FIXME -- we need to build where we explicitly add all the export HID's
  15          and where we explicitly build with each of the gui HID's (including
  16          batch).  This is needed to catch the case of missing src/hid/*/hid.conf
  17          files.
  18
  19 After following the steps below,
  20 upload the 'pcb-$VERSION.tar.gz' file to the sourceforge file release system
  21
  22
  23 To make a pcb release do the following:
  24
  25 =)      Make sure you have up to date sources
  26         git fetch
  27         git rebase origin/master
  28
  29         # note, you could also create a new local branch with
  30         # git checkout -b do_release_from_here origin/master but need to make
  31         # sure we still get the correct branch and tag on the main server eventually
  32
  33 =)      # make sure it makes distfiles ok: (have to build before doing distcheck so
  34         pcb gets built so it can create some of the images in the doc directory)
  35
  36         # clean up, and build with the GTK HID
  37         gmake distclean
  38         ./autogen.sh
  39         ./configure --disable-update-desktop-database --disable-update-mime-database
  40         gmake
  41         gmake distcheck
  42
  43         # check the build with lesstif HID.  The /usr/pkg parts should be replaced with
  44         # whatever flags (if any) are needed to find lesstif on your system.
  45         setenv DISTCHECK_CONFIGURE_FLAGS '--with-gui=lesstif CPPFLAGS=-I/usr/pkg/include CFLAGS=-I/usr/pkg/include LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib"'
  46         gmake distcheck
  47
  48         # check the build with the batch HID
  49         setenv DISTCHECK_CONFIGURE_FLAGS '--with-gui=batch'
  50         gmake distcheck
  51         unsetenv DISTCHECK_CONFIGURE_FLAGS
  52
  53 =)      commit and push any changes which were needed to fix 'distcheck' problems.
  54         Of course if the changes aren't related then they should be committed in
  55         multiple commits.
  56
  57         git commit <files>
  58         git push <files>
  59
  60 =)      update the ChangeLog with './utils/git2cl -O > ChangeLog'
  61
  62 =)      update the NEWS file with some sort of release notes
  63         summary.  You can find the number of commits with something like
  64
  65             awk '/^2008-11-28/ {print "Changes: " c ; exit} /^20[01][0-9]/ {c++}' ChangeLog
  66
  67         Commit and push NEWS and ChangeLog.
  68         git commit NEWS ChangeLog
  69         git push
  70
  71 =)      if this is a major release, then branch:
  72
  73         1. Create the release branch and push to the remove
  74                 git branch pcb-20091103
  75                 git push origin pcb-20091103
  76
  77         3. FIX_ME [fix up this step.  what shall we do with the version
  78            on the trunk?  We are about to run out of letters!]
  79            On the trunk, update configure.ac to update the version
  80                 for example 1.99x after releasing 1.99w
  81                 git checkout master
  82                 vi configure.ac
  83                 git commit configure.ac
  84                 git push
  85
  86         4. On the release branch, update configure.ac to update the version
  87                 for example 20091103_ALPHA.  Now pre-release snapshots can be made.
  88                 git checkout pcb-20091103
  89
  90         5. If desired tag an alpha release:
  91                 git checkout pcb-20091103
  92                 ./autogen.sh
  93                 git tag -a pcb-20091103-ALPHA
  94                 git checkout pcb-20091103-ALPHA
  95                 ./autogen.sh && ./configure --enable-maintainer-mode \
  96                         --disable-update-desktop-database \
  97                         --disable-update-mime-database && \
  98                         gmake && gmake distcheck
  99
 100         6. When the release branch is ready to go,  update configure.ac to
 101            set the final release version.  Then tag the release.
 102                 git checkout pcb-20091103
 103                 vi configure.ac
 104                 git commit configure.ac
 105                 ./autogen.sh
 106                 git commit -a  # after we expunge all generate files from git, we can skip this one
 107                 git push
 108                 git tag -a pcb-20091103-RELEASE
 109                 git push --tags
 110                 git checkout pcb-20091103-RELEASE
 111                 ./autogen.sh && ./configure --enable-maintainer-mode \
 112                         --disable-update-desktop-database \
 113                         --disable-update-mime-database && \
 114                         gmake clean && gmake && gmake distcheck
 115
 116         7. Create checksums
 117
 118                 openssl sha1 pcb-20091103.tar.gz > pcb-20091103.cksum
 119                 openssl md5 pcb-20091103.tar.gz >> pcb-20091103.cksum
 120                 openssl rmd160 pcb-20091103.tar.gz >> pcb-20091103.cksum
 121                 echo "File size (bytes):" >> pcb-20091103.cksum
 122                 wc -c pcb-20091103.tar.gz >> pcb-20091103.cksum
 123
 124         8. Create a new file release for pcb with a release name of
 125            "pcb-20091103" (for pcb-20091103).
 126
 127            https://sourceforge.net/projects/pcb  (you must be logged in to sourceforge)
 128
 129            Click "Develop".
 130            Click "Project Admin->File Manager".
 131            Left click on "pcb" to expand it.
 132            Right click on "pcb" and choose "New folder".  Use "pcb-20091103" as the name.
 133            Copy out the section from NEWS which are the release notes for this release.
 134            Place the into a file called pcb-20091103.txt.
 135
 136            Right click on "pcb-20091103" and choose "Uploads here".
 137            Click "Upload File" and upload the .tar.gz, .txt and .cksum files.
 138
 139            Left click on pcb-20091103.txt and check the "Release notes" box and
 140            click "Save".
 141
 142            Left click on pcb-20091103.tar.gz to bring up a form to edit the file
 143            details.  Change the label to "source code release".  Check all the platforms
 144            except for windows.  Select the release notes file and click "Save".
 145
 146            Left click on pcb-20091103.cksum to bring up a form to edit the file
 147            details.  Change the label to "checksum file", select the release notes file,
 148            and click "Save".
 149
 150 =)      return to your regularly scheduled trunk development
 151                 git checkout master
 152
 153 =)      if this is a patch release, then simply make desired changes to the branch, and
 154                 git checkout pcb-20091103
 155                 # make changes
 156                 ./autogen.sh
 157                 git commit
 158                 git tag -a pcb-20091103-PATCH001
 159                 git push
 160
 161 =)      gmake distclean ; ./autogen.sh &&./configure && gmake distcheck
 162
 163 =)      Update the web pages.  In particular, update news.shtml and index.shtml
 164         and then rebuild the corresponding .html files.