doc/HowToRelease.txt

   1
   2                      ngIRCd - Next Generation IRC Server
   3
   4                         (c)2001-2010 Alexander Barton,
   5                     alex@barton.de, http://www.barton.de/
   6
   7                ngIRCd is free software and published under the
   8                    terms of the GNU General Public License.
   9
  10                             -- HowToRelease.txt --
  11
  12
  13 I. Introduction
  14 ~~~~~~~~~~~~~~~
  15
  16 Creating a new ngIRCd release requires a few steps to follow: the source
  17 tree must be in a releasable state (be up to date, include all required
  18 patches, be tested on as many platforms as possible), a name for the new
  19 release must be chosen, and all the files describing the release must be
  20 updated accordingly.
  21
  22 Since ngIRCd release 13 (2009-12-25) we use "simple" release numbers for
  23 major releases (e.g. "13", "17", "42", ...) introducing new features and
  24 sub-releases for bug fixes only (e.g. "14.1", "22.3", ...).
  25
  26 When creating pre-releases or release candidates, please use the tilde ("~")
  27 character to separate the "postfix" in the release number (e.g. "17~rc2"
  28 or "123.4~rc6").
  29
  30 The release/version number of a build is automatically generated using the
  31 GIT "describe" command, see git-describe(1). Therefore it is required that
  32 a new release is tagged in the GIT tree and that the configure script is
  33 up-to-date (e.g. using ./autogen.sh) before generating the archives!
  34
  35
  36 II. How to prepare a new ngIRCd release?
  37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  38
  39 a) Make sure the source tree is in a releasable state ;-)
  40     - is the AUTHORS file up to date?
  41
  42 b) Make sure you have working versions of GNU autoconf and GNU automake
  43    installed on the system you use for generating the release:
  44    as of October 2010 we are using GNU autoconf 2.67 and GNU automake 1.11.1
  45    which seem to work just fine.
  46
  47 c) Update the files describing the new release:
  48     - ChangeLog
  49     - NEWS
  50
  51 d) Update the version numbers in the following files:
  52     - contrib/ngircd.spec
  53
  54 e) Generate a new Debian change log entry in the following file, e.g. using
  55    the Debian "dch" tool of the "devscripts" package:
  56     - contrib/Debian/changelog
  57
  58 f) Commit the above changes to GIT: "git add", "git commit"
  59
  60 g) Create a new signed GIT tag for the new release: "git tag -s".
  61    Please note that we don't use the tilde ("~") here, instead use a simple
  62    hyphen ("-") as delimiter: e.g. "rel-16" "rel-17-rc1", "rel-18-pre2", ...
  63
  64 h) Run "./autogen.sh" to update the ./configure script with the correct
  65    release number (autogenerated using "git describe", see above).
  66
  67 i) Run "./configure" to rebuild all generated Makefiles.
  68
  69 j) Run "make distcheck" to generate the distribution archives.
  70
  71 k) Sign the distribution archive(s) using GnuPG: "gpg -b <archivefile>"
  72
  73 l) Upload and distribute the newly generated ngIRCd release archive(s)
  74    and GnuPG signatures.
  75
  76 m) Write an announcement to the mailing list, freshmeat, Twitter, ...
  77
  78 n) Update the list of releases in our bug tracker.
  79
  80 o) Relax :-)