4 >Releasing a New Version</TITLE
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
10 TITLE="Privoxy Developer Manual"
11 HREF="index.html"><LINK
13 TITLE="Testing Guidelines"
14 HREF="testing.html"><LINK
16 TITLE="Update the Webserver"
17 HREF="webserver-update.html"><LINK
20 HREF="../p_doc.css"></HEAD
31 SUMMARY="Header navigation table"
40 >Privoxy Developer Manual</TH
62 HREF="webserver-update.html"
78 >6. Releasing a New Version</H1
80 > When we release versions of <SPAN
84 our work leaves our cozy secret lab and has to work in the cold
85 RealWorld[tm]. Once it is released, there is no way to call it
86 back, so it is very important that great care is taken to ensure
87 that everything runs fine, and not to introduce problems in the
91 > So when releasing a new version, please adhere exactly to the
92 procedure outlined in this chapter.
95 > The following programs are required to follow this process:
106 > (GNU's version of make), autoconf, cvs.
113 NAME="VERSIONNUMBERS"
115 >6.1. Version numbers</H2
117 > First you need to determine which version number the release will have.
121 > version numbers consist of three numbers,
122 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
128 > X, the version major, is rarely ever changed. It is increased by one if
129 turning a development branch into stable substantially changes the functionality,
130 user interface or configuration syntax. Majors 1 and 2 were
134 >, and 3 will be the first stable
143 > Y, the version minor, represents the branch within the major version.
144 At any point in time, there are two branches being maintained:
145 The stable branch, with an even minor, say, 2N, in which no functionality is
146 being added and only bug-fixes are made, and 2N+1, the development branch, in
147 which the further development of <SPAN
152 This enables us to turn the code upside down and inside out, while at the same time
153 providing and maintaining a stable version.
154 The minor is reset to zero (and one) when the major is incremented. When a development
155 branch has matured to the point where it can be turned into stable, the old stable branch
156 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
157 new stable branch 2N+2, and a new development branch 2N+3 is opened.
162 > Z, the point or sub version, represents a release of the software within a branch.
163 It is therefore incremented immediately before each code freeze.
164 In development branches, only the even point versions correspond to actual releases,
165 while the odd ones denote the evolving state of the sources on CVS in between.
166 It follows that Z is odd on CVS in development branches most of the time. There, it gets
167 increased to an even number immediately before a code freeze, and is increased to an odd
168 number again immediately thereafter.
169 This ensures that builds from CVS snapshots are easily distinguished from released versions.
170 The point version is reset to zero when the minor changes.
173 > Stable branches work a little differently, since there should be
174 little to no development happening in such branches. Remember,
175 only bugfixes, which presumably should have had some testing
176 before being committed. Stable branches will then have their
177 version reported as <TT
180 >, during that period
181 between releases when changes are being added. This is to denote
182 that this code is <SPAN
189 as the release nears, the version is bumped according: e.g.
192 >3.0.1 -> 0.0.0 -> 3.0.2</TT
200 > In summary, the main CVS trunk is the development branch where new
201 features are being worked on for the next stable series. This should
202 almost always be where the most activity takes place. There is always at
203 least one stable branch from the trunk, e.g now it is
207 >, which is only used to release stable versions.
208 Once the initial *.0 release of the stable branch has been done, then as a
209 rule, only bugfixes that have had prior testing should be committed to
210 the stable branch. Once there are enough bugfixes to justify a new
211 release, the version of this branch is again incremented Example: 3.0.0
212 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
213 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
214 taking place. If any questions, please post to the devel list
221 > committing to a stable branch!
224 > Developers should remember too that if they commit a bugfix to the stable
225 branch, this will more than likely require a separate submission to the
226 main trunk, since these are separate development trees within CVS. If you
227 are working on both, then this would require at least two separate check
228 outs (i.e main trunk, <SPAN
234 > the stable release branch,
248 >6.2. Before the Release: Freeze</H2
250 > The following <SPAN
254 >must be done by one of the
257 > prior to each new release.
265 > Make sure that everybody who has worked on the code in the last
266 couple of days has had a chance to yell <SPAN
270 they have pending changes/fixes in their pipelines. Announce the
271 freeze so that nobody will interfere with last minute changes.
276 > Increment the version number (point from odd to even in development
281 will need to be incremented as well.)
289 > has changed since last
290 release (i.e. software release or standalone actions file release),
291 bump up its version info to A.B in this line:
302 CLASS="PROGRAMLISTING"
303 > {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}</PRE
311 Then change the version info in doc/webserver/actions/index.php,
312 line: '$required_actions_file_version = "A.B";'
317 > All documentation should be rebuild after the version bump.
318 Finished docs should be then be committed to CVS (for those
319 without the ability to build these). Some docs may require
320 rather obscure processing tools. <TT
324 the man page (and the html version of the man page), and the PDF docs
325 fall in this category. REAMDE, the man page, AUTHORS, and config
326 should all also be committed to CVS for other packagers. The
327 formal docs should be uploaded to the webserver. See the
328 Section "Updating the webserver" in this manual for details.
336 > is also used for context
337 sensitive help for the CGI editor. This is version sensitive, so that
338 the user will get appropriate help for his/her release. So with
339 each release a fresh version should be uploaded to the webserver
340 (this is in addition to the main <I
344 link from the main page since we need to keep manuals for various
345 versions available). The CGI pages will link to something like
348 >http://privoxy.org/$(VERSION)/user-manual/</TT
350 will need to be updated for each new release. There is no Makefile
351 target for this at this time!!! It needs to be done manually.
356 > All developers should look at the <TT
360 make sure noteworthy changes are referenced.
369 >Commit all files that were changed in the above steps!</I
376 > Tag all files in CVS with the version number with
384 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
389 > If the release was in a development branch, increase the point version
390 from even to odd (X.Y.(Z+1)) again in <TT
399 > On the webserver, copy the user manual to a new top-level directory
403 >. This ensures that help links from the CGI
404 pages, which have the version as a prefix, will go into the right version of the manual.
405 If this is a development branch release, also symlink <TT
433 >6.3. Building and Releasing the Packages</H2
435 > Now the individual packages can be built and released. Note that for
436 GPL reasons the first package to be released is always the source tarball.
445 > types of packages, including the source tarball,
450 >you must make sure that you build from clean sources by exporting
451 the right version from CVS into an empty directory</I
453 > (just press return when
454 asked for a password):
464 CLASS="PROGRAMLISTING"
465 > mkdir dist # delete or choose different name if it already exists
467 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
468 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
481 > a single bit, including, but not limited to
482 version information after export from CVS. This is to make sure that
483 all release packages, and with them, all future bug reports, are based
484 on exactly the same code.
505 > Every significant release of Privoxy has included at least one
506 package that either had incorrect versions of files, missing files,
507 or incidental leftovers from a previous build process that gave
508 unknown numbers of users headaches to try to figure out what was
509 wrong. PLEASE, make sure you are using pristene sources, and are
510 following the prescribed process!
517 > Please find additional instructions for the source tarball and the
518 individual platform dependent binary packages below. And details
519 on the Sourceforge release process below that.
526 NAME="PACK-GUIDELINES"
528 >6.3.1. Note on Privoxy Packaging</H3
530 > Please keep these general guidelines in mind when putting together
531 your package. These apply to <SPAN
555 write access to: all <TT
559 logfiles, and the <TT
563 need to determine the best way to do this for your platform.
568 > Please include up to date documentation. At a bare minimum:
580 > (top-level directory)
597 > (top-level directory)
614 > (top-level directory)
631 > (top-level directory, Unix-like
649 > (doc/webserver/user-manual/)
666 > (doc/webserver/faq/)
674 > Also suggested: <TT
676 >Developer Manual</TT
678 (doc/webserver/developer-manual) and <TT
682 (top-level directory). <TT
685 > and the manuals are
686 HTML docs. There are also text versions in
690 > which could conceivably also be
694 > The documentation has been designed such that the manuals are linked
695 to each other from parallel directories, and should be packaged
698 >privoxy-index.html</TT
700 included and can serve as a focal point for docs and other links of
701 interest (and possibly renamed to <TT
705 This should be one level up from the manuals. There is a link also
706 on this page to an HTMLized version of the man page. To avoid 404 for
707 this, it is in CVS as
710 >doc/webserver/man-page/privoxy-man-page.html</TT
712 and should be included along with the manuals. There is also a
713 css stylesheets that can be included for better presentation:
717 >. This should be in the same directory
720 >privoxy-index.html</TT
721 >, (i.e. one level up from
722 the manual directories).
734 are designed for local preferences. Make sure these do not get overwritten!
738 > should not be overwritten either. This
739 has especially important configuration data in it.
743 > should be left in tact as well.
748 > Other configuration files (<TT
759 >) should be installed as the new
760 defaults, but all previously installed configuration files should be
761 preserved as backups. This is just good manners :-) These files are
762 likely to change between releases and contain important new features
768 > Please check platform specific notes in this doc, if you haven't
772 > packaging before for other platform
773 specific issues. Conversely, please add any notes that you know
774 are important for your platform (or contact one of the doc
775 maintainers to do this if you can't).
780 > Packagers should do a <SPAN
784 package after building it. So any previous installs should be
785 removed first to ensure the integrity of the newly built package.
786 Then run the package for a while to make sure there are no
787 obvious problems, before uploading.
799 NAME="NEWRELEASE-TARBALL"
801 >6.3.2. Source Tarball</H3
807 >make sure that you have freshly exported the right
808 version into an empty directory</I
810 >. (See "Building and releasing
811 packages" above). Then run:
821 CLASS="PROGRAMLISTING"
823 autoheader && autoconf && ./configure</PRE
840 CLASS="PROGRAMLISTING"
841 > make tarball-dist</PRE
848 > To upload the package to Sourceforge, simply issue
858 CLASS="PROGRAMLISTING"
859 > make tarball-upload</PRE
866 > Go to the displayed URL and release the file publicly on Sourceforge.
867 For the change log field, use the relevant section of the
879 NAME="NEWRELEASE-RPM"
881 >6.3.3. SuSE, Conectiva or Red Hat RPM</H3
883 > In following text, replace <TT
892 > for Red Hat or <SPAN
902 >make sure that you have freshly exported the right
903 version into an empty directory</I
905 >. (See "Building and releasing
909 > As the only exception to not changing anything after export from CVS,
910 now examine the file <TT
922 and make sure that the version information and the RPM release number are
923 correct. The RPM release numbers for each version start at one. Hence it must
924 be reset to one if this is the first RPM for
930 > which is built from version
933 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
937 > if unsure. Else, it must be set to the highest already available RPM
938 release number for that version plus one.
951 CLASS="PROGRAMLISTING"
953 autoheader && autoconf && ./configure</PRE
970 CLASS="PROGRAMLISTING"
983 > To upload the package to Sourceforge, simply issue
993 CLASS="PROGRAMLISTING"
1017 RPM release number as determined above.
1018 Go to the displayed URL and release the file publicly on Sourceforge.
1019 Use the release notes and change log from the source tarball package.
1027 NAME="NEWRELEASE-OS2"
1035 >make sure that you have freshly exported the right
1036 version into an empty directory</I
1038 >. (See "Building and releasing
1039 packages" above). Then get the OS/2 Setup module:
1049 CLASS="PROGRAMLISTING"
1050 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
1057 > You will need a mix of development tools.
1058 The main compilation takes place with IBM Visual Age C++.
1059 Some ancillary work takes place with GNU tools, available from
1060 various sources like hobbes.nmsu.edu.
1061 Specificially, you will need <TT
1072 The packaging takes place with WarpIN, available from various sources, including
1074 HREF="http://www.xworkplace.org/"
1080 > Change directory to the <TT
1084 Edit the os2build.cmd file to set the final executable filename.
1095 CLASS="PROGRAMLISTING"
1096 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
1103 > Next, edit the <TT
1106 > file so the release number matches
1120 CLASS="PROGRAMLISTING"
1121 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
1128 > You're now ready to build. Run:
1138 CLASS="PROGRAMLISTING"
1146 > You will find the WarpIN-installable executable in the
1150 > directory. Upload this anonymously to
1153 >uploads.sourceforge.net/incoming</TT
1155 for it, and you're done. Use the release notes and Change Log from the
1156 source tarball package.
1164 NAME="NEWRELEASE-SOLARIS"
1168 > Login to Sourceforge's compilefarm via ssh:
1178 CLASS="PROGRAMLISTING"
1179 > ssh cf.sourceforge.net</PRE
1186 > Choose the right operating system (not the Debian one).
1187 When logged in, <SPAN
1191 >make sure that you have freshly exported the right
1192 version into an empty directory</I
1194 >. (See "Building and releasing
1195 packages" above). Then run:
1205 CLASS="PROGRAMLISTING"
1207 autoheader && autoconf && ./configure</PRE
1224 CLASS="PROGRAMLISTING"
1225 > gmake solaris-dist</PRE
1232 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1236 > on the Sourceforge machine (no ncftpput). You now have
1237 to manually upload the archive to Sourceforge's ftp server and release
1238 the file publicly. Use the release notes and Change Log from the
1239 source tarball package.
1247 NAME="NEWRELEASE-WINDOWS"
1251 > You should ensure you have the latest version of Cygwin (from
1253 HREF="http://www.cygwin.com/"
1255 >http://www.cygwin.com/</A
1257 Run the following commands from within a Cygwin bash shell.
1264 >make sure that you have freshly exported the right
1265 version into an empty directory</I
1267 >. (See "Building and releasing
1268 packages" above). Then get the Windows setup module:
1278 CLASS="PROGRAMLISTING"
1279 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1286 > Then you can build the package. This is fully automated, and is
1289 >winsetup/GNUmakefile</TT
1291 All you need to do is:
1301 CLASS="PROGRAMLISTING"
1310 > Now you can manually rename <TT
1312 >privoxy_setup.exe</TT
1316 >privoxy_setup_X_Y_Z.exe</TT
1318 SourceForge. When releasing the package on SourceForge, use the release notes
1319 and Change Log from the source tarball package.
1327 NAME="NEWRELEASE-DEBIAN"
1335 >make sure that you have freshly exported the
1336 right version into an empty directory</I
1339 "Building and releasing packages" above). Then add a log
1342 >debian/changelog</TT
1344 already there, for example by running:
1354 CLASS="PROGRAMLISTING"
1355 > debchange -v 3.0.5-BETA-1 "New upstream version"</PRE
1372 CLASS="PROGRAMLISTING"
1373 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1383 >../privoxy_3.0.5-BETA-1_i386.deb</TT
1385 which can be uploaded. To upload the package to Sourceforge, simply
1396 CLASS="PROGRAMLISTING"
1397 > make debian-upload</PRE
1409 NAME="NEWRELEASE-MACOSX"
1417 >make sure that you have freshly exported the right
1418 version into an empty directory</I
1420 >. (See "Building and releasing
1421 packages" above). Then get the Mac OSX setup module:
1431 CLASS="PROGRAMLISTING"
1432 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1449 CLASS="PROGRAMLISTING"
1472 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1473 for further processing by <TT
1479 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1480 name to match the release, and hit the "Create package" button.
1481 If you specify ./Privoxy.pkg as the output package name, you can then create
1482 the distributable zip file with the command:
1492 CLASS="PROGRAMLISTING"
1493 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1500 > You can then upload <TT
1502 >privoxyosx_setup_x.y.z.zip</TT
1506 >uploads.sourceforge.net/incoming</TT
1508 create a release for it, and you're done. Use the release notes
1509 and Change Log from the source tarball package.
1517 NAME="NEWRELEASE-FREEBSD"
1521 > Login to Sourceforge's compile-farm via ssh:
1531 CLASS="PROGRAMLISTING"
1532 > ssh cf.sourceforge.net</PRE
1539 > Choose the right operating system.
1540 When logged in, <SPAN
1544 >make sure that you have freshly exported the right
1545 version into an empty directory</I
1547 >. (See "Building and releasing
1548 packages" above). Then run:
1558 CLASS="PROGRAMLISTING"
1560 autoheader && autoconf && ./configure</PRE
1577 CLASS="PROGRAMLISTING"
1578 > gmake freebsd-dist</PRE
1585 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1589 > on the Sourceforge machine (no ncftpput). You now have
1590 to manually upload the archive to Sourceforge's ftp server and release
1591 the file publicly. Use the release notes and Change Log from the
1592 source tarball package.
1600 NAME="NEWRELEASE-HPUX"
1602 >6.3.10. HP-UX 11</H3
1608 >make sure that you have freshly exported the right
1609 version into an empty directory</I
1611 >. (See "Building and releasing
1612 packages" above). Then run:
1622 CLASS="PROGRAMLISTING"
1624 autoheader && autoconf && ./configure</PRE
1639 NAME="NEWRELEASE-AMIGA"
1641 >6.3.11. Amiga OS</H3
1647 >make sure that you have freshly exported the right
1648 version into an empty directory</I
1650 >. (See "Building and releasing
1651 packages" above). Then run:
1661 CLASS="PROGRAMLISTING"
1663 autoheader && autoconf && ./configure</PRE
1678 NAME="NEWRELEASE-AIX"
1682 > Login to Sourceforge's compilefarm via ssh:
1692 CLASS="PROGRAMLISTING"
1693 > ssh cf.sourceforge.net</PRE
1700 > Choose the right operating system.
1701 When logged in, <SPAN
1705 >make sure that you have freshly exported the right
1706 version into an empty directory</I
1708 >. (See "Building and releasing
1709 packages" above). Then run:
1719 CLASS="PROGRAMLISTING"
1721 autoheader && autoconf && ./configure</PRE
1738 CLASS="PROGRAMLISTING"
1739 > make aix-dist</PRE
1746 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1750 > on the Sourceforge machine (no ncftpput). You now have
1751 to manually upload the archive to Sourceforge's ftp server and release
1752 the file publicly. Use the release notes and Change Log from the
1753 source tarball package.
1764 >6.4. Uploading and Releasing Your Package</H2
1766 > After the package is ready, it is time to upload it
1767 to SourceForge, and go through the release steps. The upload
1777 HREF="ftp://upload.sourceforge.net/incoming"
1779 >ftp://upload.sourceforge.net/incoming</A
1795 >ijbswa-developers@lists.sourceforge.net</TT
1806 > targets as described above.
1809 > Once this done go to <A
1810 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1812 >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1814 making sure you are logged in. Find your target platform in the
1815 second column, and click <TT
1819 then need to create a new release for your package, using the format
1822 >$VERSION ($CODE_STATUS)</TT
1833 > Now just follow the prompts. Be sure to add any appropriate Release
1834 notes. You should see your freshly uploaded packages in
1837 >"Step 2. Add Files To This Release"</SPAN
1839 appropriate box(es). Remember at each step to hit the
1842 >"Refresh/Submit"</SPAN
1843 > buttons! You should now see your
1844 file(s) listed in Step 3. Fill out the forms with the appropriate
1845 information for your platform, being sure to hit <SPAN
1849 for each file. If anyone is monitoring your platform, check the
1853 > box at the very bottom to notify them of
1854 the new package. This should do it!
1857 > If you have made errors, or need to make changes, you can go through
1858 essentially the same steps, but select <TT
1875 >6.5. After the Release</H2
1877 > When all (or: most of the) packages have been uploaded and made available,
1878 send an email to the <A
1879 HREF="mailto:ijbswa-announce@lists.sourceforge.net"
1883 >, Subject: "Version X.Y.Z available for download". Be sure to
1886 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
1890 >, the release notes and the Changelog. Also, post an
1891 updated News item on the project page Sourceforge, and update the Home
1892 page and docs linked from the Home page (see below). Other news sites
1893 and release oriented sites, such as Freshmeat, should also be notified.
1902 SUMMARY="Footer navigation table"
1931 HREF="webserver-update.html"
1941 >Testing Guidelines</TD
1951 >Update the Webserver</TD