Changes between Version 1 and Version 2 of ReleaseProcedure

Timestamp:

Aug 15, 2007, 12:37:30 PM (17 years ago)

Author:

Jari Häkkinen

Comment:

Working on the release procedure. Refs ticket:656

ReleaseProcedure

@@ -5 +5 @@
 These instructions cover how to release minor and patch releases in a
 project that uses trac/subversion for revision control and project
-management. How to release major releases is not covered yet since we
-have not done that (with the exception of the first release). Release
+management. How to release major releases is not covered yet. Release
 numbering follows the normal convention of major.minor.patch and the
 APR (see http://apr.apache.org/versioning.html) guidelines for
@@ -18 +17 @@
 every time a new patch release is made. Remember, patch work should be
 limited to bug fixes and important fixes only leaving development of
-new features and designs to the trunk branch.
+new features and designs to the trunk branch, or other special branches.
 
 Releases should only be performed by an appointed member of the team,
@@ -31 +30 @@
 
  1. Make sure that all commits are performed into to the trunk, such
-    as bumping version number(s) ([source:trunk/configure.ac configure.ac]),
-    acknowledge contributions ([source:trunk/THANKS THANKS]), update
-    files [source:trunk/NEWS NEWS] and [source:trunk/ChangeLog ChangeLog].
+    as bumping version number(s) ([source:trunk/build.xml build.xml]),
+    acknowledge contributions ([source:trunk/credits.txt credits.txt]),
+    API changes that may affect backwards compatibility
+    ([http://base.thep.lu.se/chrome/site/doc/html/appendix/appendix.incompatible.html API changes]),
+    and other files as necessary.
     [[br]][[br]]
-  i. Update version number in [source:trunk/configure.ac configure.ac]. Locate and change the
-     below line
-{{{
-AC_INIT([svndigest],[A.B],[jari.at.thep.lu.se])
-}}}
-  i. Update [source:trunk/THANKS THANKS]. Remember, ego and vanity is the currency of open
+  i. Update version number in [source:trunk/build.xml build.xml]. Locate and change the
+     below line
+{{{
+<property name="base.minorversion" value="B" />
+}}}
+  i. Update [source:trunk/credits.txt credits.txt]. Remember, ego and vanity is the currency of open
      source projects. Well, there are other reasons for open source
-     projects but [source:trunk/THANKS THANKS] is for boosting peoples' ego. [[br]][[br]]
-  i. Set the date for the new release in [source:trunk/NEWS NEWS]
-{{{
-version A.B (released 26 June 2007)
-}}}
-    Make sure that the items in [source:trunk/NEWS NEWS] cover the new features of the
-    release. [[br]][[br]]
-  i. Finalize the links to trac in [source:trunk/ChangeLog ChangeLog]
-{{{
-version A.B:
-        - http://trac.thep.lu.se/trac/svndigest/log/trunk?rev=N&stop_rev=M
-        - http://trac.thep.lu.se/trac/svndigest/query?milestone=A.B&order=id
-}}}
-     where M should be current HEAD+2 (2 more commits are needed before release).
-     [[br]][[br]]
+     projects but [source:trunk/credits.txt credits.txt] is for boosting peoples' ego. [[br]][[br]]
+  i. Make sure that the API incompatibility list is up to date
+     [http://base.thep.lu.se/chrome/site/doc/html/appendix/appendix.incompatible.html API changes].
+     This document should really be changed as the API changes, please do not leave this task to be
+     done at the last minute of release.
+  i. Make other changes as needed. If items are missing from this list, please add them with proper
+     instructions for the items changes maintenance.
   i. Commit changes to the repository, `svn ci -m "Preparing release A.B"`
      [[br]][[br]]
- 1. Update copyright statements with commands
-{{{
-./bootstrap
-make all
-make check
+ 1. Update copyright statements with
+{{{
 ./bin/svndigest --copyright
 }}}
- Examine the updates and commit changes with `svn ci -m "updating copyright statements"`[[br]][[br]]
+    Examine the updates and commit changes with `svn ci -m "updating copyright statements"`. For
+    this step [http://trac.thep.lu.se/trac/svndigest svndigest] is obviously needed. [[br]][[br]]
  1. Needless to say, make sure that the program is in a state to be
     released; make sure that all the tests pass, test the distribution
@@ -72 +63 @@
     appropriate:
 {{{
-./bootstrap
-make check
-make distcheck
-}}}
+Please add test command sequence here
+}}}
+    If you fail in this step, please resolve the issues and restart these procedures. [[br]][[br]]
  1. Create a tag using a one liner like
 {{{
-svn copy http://lev.thep.lu.se/repository/svndigest/trunk \
-    http://lev.thep.lu.se/repository/svndigest/tags/A.B \
+svn copy http://lev.thep.lu.se/repository/base/trunk \
+    http://lev.thep.lu.se/repository/base/tags/A.B \
     -m "Tagging version A.B"
 }}}
  1. Update the version list in Trac using the
-    [http://trac.thep.lu.se/trac/svndigest/admin trac-admin tool].
+    [http://base.thep.lu.se/admin trac-admin tool].
     [[br]][[br]]
  1. Create a distribution package:
 {{{
-svn co http://lev.thep.lu.se/repository/svndigest/tags/A.B A.B_dist
+svn co http://lev.thep.lu.se/repository/base/tags/A.B A.B_dist
 cd A.B_dist
-./bootstrap
-./configure [OPTION]...
-make dist
+ant package
 }}}
     Attach the new package to the DownloadPage.  Remove `A.B_dist`
@@ -115 +103 @@
  1. Create a new minor branch using a one liner like
 {{{
-svn copy http://lev.thep.lu.se/repository/svndigest/tags/A.B \
-    http://lev.thep.lu.se/repository/svndigest/branches/A.B-stable \
+svn copy http://lev.thep.lu.se/repository/base/tags/A.B \
+    http://lev.thep.lu.se/repository/base/branches/A.B-stable \
     -m "New minor version A.B branch"
 }}}
@@ -122 +110 @@
   i. Check out the new minor branch
 {{{
-svn co http://lev.thep.lu.se/repository/svndigest/branches/A.B-stable A.B
-}}}
-  i. Update version number in `configure.ac`. Locate and change the
+svn co http://lev.thep.lu.se/repository/base/branches/A.B-stable A.B
+}}}
+  i. Update version number in `build.xml`. Locate and change the
      below line
 {{{