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