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"
76 NAME="NEWRELEASE">6. Releasing a New Version</H1
78 > When we release versions of <SPAN
82 our work leaves our cozy secret lab and has to work in the cold
83 RealWorld[tm]. Once it is released, there is no way to call it
84 back, so it is very important that great care is taken to ensure
85 that everything runs fine, and not to introduce problems in the
89 > So when releasing a new version, please adhere exactly to the
90 procedure outlined in this chapter.
93 > The following programs are required to follow this process:
104 > (GNU's version of make), autoconf, cvs.
111 NAME="VERSIONNUMBERS">6.1. Version numbers</H2
113 > First you need to determine which version number the release will have.
117 > version numbers consist of three numbers,
118 separated by dots, like in X.Y.Z, where:
124 > X, the version major, is rarely ever changed. It is increased by one if
125 turning a development branch into stable substantially changes the functionality,
126 user interface or configuration syntax. Majors 1 and 2 were
130 >, and 3 will be the first stable
139 > Y, the version minor, represents the branch within the major version.
140 At any point in time, there are two branches being maintained:
141 The stable branch, with an even minor, say, 2N, in which no functionality is
142 being added and only bug-fixes are made, and 2N+1, the development branch, in
143 which the further development of <SPAN
148 This enables us to turn the code upside down and inside out, while at the same time
149 providing and maintaining a stable version.
150 The minor is reset to zero (and one) when the major is incremented. When a development
151 branch has matured to the point where it can be turned into stable, the old stable branch
152 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
153 new stable branch 2N+2, and a new development branch 2N+3 is opened.
158 > Z, the point or sub version, represents a release of the software within a branch.
159 It is therefore incremented immediately before each code freeze.
160 In development branches, only the even point versions correspond to actual releases,
161 while the odd ones denote the evolving state of the sources on CVS in between.
162 It follows that Z is odd on CVS in development branches most of the time. There, it gets
163 increased to an even number immediately before a code freeze, and is increased to an odd
164 number again immediately thereafter.
165 This ensures that builds from CVS snapshots are easily distinguished from released versions.
166 The point version is reset to zero when the minor changes.
178 NAME="BEFORERELEASE">6.2. Before the Release: Freeze</H2
180 > The following <SPAN
184 >must be done by one of the
187 > prior to each new release.
195 > Make sure that everybody who has worked on the code in the last
196 couple of days has had a chance to yell <SPAN
200 they have pending changes/fixes in their pipelines. Announce the
201 freeze so that nobody will interfere with last minute changes.
206 > Increment the version number (point from odd to even in development
211 will need to be incremented as well.)
219 > has changed since last
220 release (i.e. software release or standalone actions file release),
221 bump up its version info to A.B in this line:
232 CLASS="PROGRAMLISTING"
233 > {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}</PRE
241 Then change the version info in doc/webserver/actions/index.php,
242 line: '$required_actions_file_version = "A.B";'
247 > All documentation should be rebuild after the version bump.
248 Finished docs should be then be committed to CVS (for those
249 without the ability to build these). Some docs may require
250 rather obscure processing tools. <TT
254 the man page (and the html version of the man page), and the PDF docs
255 fall in this category. REAMDE, the man page, AUTHORS, and config
256 should all also be committed to CVS for other packagers. The
257 formal docs should be uploaded to the webserver. See the
258 Section "Updating the webserver" in this manual for details.
266 > is also used for context
267 sensitive help for the CGI editor. This is version sensitive, so that
268 the user will get appropriate help for his/her release. So with
269 each release a fresh version should be uploaded to the webserver
270 (this is in addition to the main <I
274 link from the main page since we need to keep manuals for various
275 versions available). The CGI pages will link to something like
278 >http://privoxy.org/$(VERSION)/user-manual/</TT
280 will need to be updated for each new release. There is no Makefile
281 target for this at this time!!! It needs to be done manually.
286 > All developers should look at the <TT
290 make sure noteworthy changes are referenced.
299 >Commit all files that were changed in the above steps!</I
306 > Tag all files in CVS with the version number with
314 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
319 > If the release was in a development branch, increase the point version
320 from even to odd (X.Y.(Z+1)) again in <TT
329 > On the webserver, copy the user manual to a new top-level directory
333 >. This ensures that help links from the CGI
334 pages, which have the version as a prefix, will go into the right version of the manual.
335 If this is a development branch release, also symlink <TT
361 NAME="THERELEASE">6.3. Building and Releasing the Packages</H2
363 > Now the individual packages can be built and released. Note that for
364 GPL reasons the first package to be released is always the source tarball.
373 > types of packages, including the source tarball,
378 >you must make sure that you build from clean sources by exporting
379 the right version from CVS into an empty directory</I
381 > (just press return when
382 asked for a password):
392 CLASS="PROGRAMLISTING"
393 > mkdir dist # delete or choose different name if it already exists
395 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
396 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
409 > a single bit, including, but not limited to
410 version information after export from CVS. This is to make sure that
411 all release packages, and with them, all future bug reports, are based
412 on exactly the same code.
415 > Please find additional instructions for the source tarball and the
416 individual platform dependent binary packages below. And details
417 on the Sourceforge release process below that.
424 NAME="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</H3
426 > Please keep these general guidelines in mind when putting together
427 your package. These apply to <SPAN
451 write access to: all <TT
455 logfiles, and the <TT
459 need to determine the best way to do this for your platform.
464 > Please include up to date documentation. At a bare minimum:
476 > (top-level directory)
493 > (top-level directory)
510 > (top-level directory)
527 > (top-level directory, Unix-like
545 > (doc/webserver/user-manual/)
562 > (doc/webserver/faq/)
570 > Also suggested: <TT
572 >Developer Manual</TT
574 (doc/webserver/developer-manual) and <TT
578 (top-level directory). <TT
581 > and the manuals are
582 HTML docs. There are also text versions in
586 > which could conceivably also be
590 > The documentation has been designed such that the manuals are linked
591 to each other from parallel directories, and should be packaged
594 >privoxy-index.html</TT
596 included and can serve as a focal point for docs and other links of
597 interest (and possibly renamed to <TT
601 This should be one level up from the manuals. There is a link also
602 on this page to an HTMLized version of the man page. To avoid 404 for
603 this, it is in CVS as
606 >doc/webserver/man-page/privoxy-man-page.html</TT
608 and should be included along with the manuals. There is also a
609 css stylesheets that can be included for better presentation:
613 >. This should be in the same directory
616 >privoxy-index.html</TT
617 >, (i.e. one level up from
618 the manual directories).
626 > is designed for local preferences.
627 Make sure this does not get overwritten!
632 > Other configuration files should be installed as the new defaults,
633 but all previously installed configuration files should be preserved
634 as backups. This is just good manners :-)
639 > Please check platform specific notes in this doc, if you haven't
643 > packaging before for other platform
644 specific issues. Conversely, please add any notes that you know
645 are important for your platform (or contact one of the doc
646 maintainers to do this if you can't).
651 > Packagers should do a <SPAN
655 package after building it. So any previous installs should be
656 removed first to ensure the integrity of the newly built package.
657 Then run the package for a while to make sure there are no
658 obvious problems, before uploading.
670 NAME="NEWRELEASE-TARBALL">6.3.2. Source Tarball</H3
676 >make sure that you have freshly exported the right
677 version into an empty directory</I
679 >. (See "Building and releasing
680 packages" above). Then run:
690 CLASS="PROGRAMLISTING"
692 autoheader && autoconf && ./configure</PRE
709 CLASS="PROGRAMLISTING"
710 > make tarball-dist</PRE
717 > To upload the package to Sourceforge, simply issue
727 CLASS="PROGRAMLISTING"
728 > make tarball-upload</PRE
735 > Go to the displayed URL and release the file publicly on Sourceforge.
736 For the change log field, use the relevant section of the
748 NAME="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</H3
750 > In following text, replace <TT
759 > for Red Hat or <SPAN
769 >make sure that you have freshly exported the right
770 version into an empty directory</I
772 >. (See "Building and releasing
776 > As the only exception to not changing anything after export from CVS,
777 now examine the file <TT
789 and make sure that the version information and the RPM release number are
790 correct. The RPM release numbers for each version start at one. Hence it must
791 be reset to one if this is the first RPM for
797 > which is built from version
800 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
804 > if unsure. Else, it must be set to the highest already available RPM
805 release number for that version plus one.
818 CLASS="PROGRAMLISTING"
820 autoheader && autoconf && ./configure</PRE
837 CLASS="PROGRAMLISTING"
850 > To upload the package to Sourceforge, simply issue
860 CLASS="PROGRAMLISTING"
884 RPM release number as determined above.
885 Go to the displayed URL and release the file publicly on Sourceforge.
886 Use the release notes and change log from the source tarball package.
894 NAME="NEWRELEASE-OS2">6.3.4. OS/2</H3
900 >make sure that you have freshly exported the right
901 version into an empty directory</I
903 >. (See "Building and releasing
904 packages" above). Then get the OS/2 Setup module:
914 CLASS="PROGRAMLISTING"
915 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
922 > You will need a mix of development tools.
923 The main compilation takes place with IBM Visual Age C++.
924 Some ancillary work takes place with GNU tools, available from
925 various sources like hobbes.nmsu.edu.
926 Specificially, you will need <TT
937 The packaging takes place with WarpIN, available from various sources, including
939 HREF="http://www.xworkplace.org/"
945 > Change directory to the <TT
949 Edit the os2build.cmd file to set the final executable filename.
960 CLASS="PROGRAMLISTING"
961 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
971 > file so the release number matches
985 CLASS="PROGRAMLISTING"
986 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
993 > You're now ready to build. Run:
1003 CLASS="PROGRAMLISTING"
1011 > You will find the WarpIN-installable executable in the
1015 > directory. Upload this anonymously to
1018 >uploads.sourceforge.net/incoming</TT
1020 for it, and you're done. Use the release notes and Change Log from the
1021 source tarball package.
1029 NAME="NEWRELEASE-SOLARIS">6.3.5. Solaris</H3
1031 > Login to Sourceforge's compilefarm via ssh:
1041 CLASS="PROGRAMLISTING"
1042 > ssh cf.sourceforge.net</PRE
1049 > Choose the right operating system (not the Debian one).
1050 When logged in, <SPAN
1054 >make sure that you have freshly exported the right
1055 version into an empty directory</I
1057 >. (See "Building and releasing
1058 packages" above). Then run:
1068 CLASS="PROGRAMLISTING"
1070 autoheader && autoconf && ./configure</PRE
1087 CLASS="PROGRAMLISTING"
1088 > gmake solaris-dist</PRE
1095 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1099 > on the Sourceforge machine (no ncftpput). You now have
1100 to manually upload the archive to Sourceforge's ftp server and release
1101 the file publicly. Use the release notes and Change Log from the
1102 source tarball package.
1110 NAME="NEWRELEASE-WINDOWS">6.3.6. Windows</H3
1112 > You should ensure you have the latest version of Cygwin (from
1114 HREF="http://www.cygwin.com/"
1116 >http://www.cygwin.com/</A
1118 Run the following commands from within a Cygwin bash shell.
1125 >make sure that you have freshly exported the right
1126 version into an empty directory</I
1128 >. (See "Building and releasing
1129 packages" above). Then get the Windows setup module:
1139 CLASS="PROGRAMLISTING"
1140 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1147 > Then you can build the package. This is fully automated, and is
1150 >winsetup/GNUmakefile</TT
1152 All you need to do is:
1162 CLASS="PROGRAMLISTING"
1171 > Now you can manually rename <TT
1173 >privoxy_setup.exe</TT
1177 >privoxy_setup_X_Y_Z.exe</TT
1179 SourceForge. When releasing the package on SourceForge, use the release notes
1180 and Change Log from the source tarball package.
1188 NAME="NEWRELEASE-DEBIAN">6.3.7. Debian</H3
1194 >make sure that you have freshly exported the
1195 right version into an empty directory</I
1198 "Building and releasing packages" above). Then add a log
1201 >debian/changelog</TT
1203 already there, for example by running:
1213 CLASS="PROGRAMLISTING"
1214 > debchange -v 3.0.0-stable-1 "New upstream version"</PRE
1231 CLASS="PROGRAMLISTING"
1232 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1242 >../privoxy_3.0.0-stable-1_i386.deb</TT
1244 which can be uploaded. To upload the package to Sourceforge, simply
1255 CLASS="PROGRAMLISTING"
1256 > make debian-upload</PRE
1268 NAME="NEWRELEASE-MACOSX">6.3.8. Mac OSX</H3
1274 >make sure that you have freshly exported the right
1275 version into an empty directory</I
1277 >. (See "Building and releasing
1278 packages" above). Then get the Mac OSX setup module:
1288 CLASS="PROGRAMLISTING"
1289 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1306 CLASS="PROGRAMLISTING"
1329 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1330 for further processing by <TT
1336 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1337 name to match the release, and hit the "Create package" button.
1338 If you specify ./Privoxy.pkg as the output package name, you can then create
1339 the distributable zip file with the command:
1349 CLASS="PROGRAMLISTING"
1350 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1357 > You can then upload <TT
1359 >privoxyosx_setup_x.y.z.zip</TT
1363 >uploads.sourceforge.net/incoming</TT
1365 create a release for it, and you're done. Use the release notes
1366 and Change Log from the source tarball package.
1374 NAME="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</H3
1376 > Login to Sourceforge's compile-farm via ssh:
1386 CLASS="PROGRAMLISTING"
1387 > ssh cf.sourceforge.net</PRE
1394 > Choose the right operating system.
1395 When logged in, <SPAN
1399 >make sure that you have freshly exported the right
1400 version into an empty directory</I
1402 >. (See "Building and releasing
1403 packages" above). Then run:
1413 CLASS="PROGRAMLISTING"
1415 autoheader && autoconf && ./configure</PRE
1432 CLASS="PROGRAMLISTING"
1433 > gmake freebsd-dist</PRE
1440 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1444 > on the Sourceforge machine (no ncftpput). You now have
1445 to manually upload the archive to Sourceforge's ftp server and release
1446 the file publicly. Use the release notes and Change Log from the
1447 source tarball package.
1455 NAME="NEWRELEASE-HPUX">6.3.10. HP-UX 11</H3
1461 >make sure that you have freshly exported the right
1462 version into an empty directory</I
1464 >. (See "Building and releasing
1465 packages" above). Then run:
1475 CLASS="PROGRAMLISTING"
1477 autoheader && autoconf && ./configure</PRE
1492 NAME="NEWRELEASE-AMIGA">6.3.11. Amiga OS</H3
1498 >make sure that you have freshly exported the right
1499 version into an empty directory</I
1501 >. (See "Building and releasing
1502 packages" above). Then run:
1512 CLASS="PROGRAMLISTING"
1514 autoheader && autoconf && ./configure</PRE
1529 NAME="NEWRELEASE-AIX">6.3.12. AIX</H3
1531 > Login to Sourceforge's compilefarm via ssh:
1541 CLASS="PROGRAMLISTING"
1542 > ssh cf.sourceforge.net</PRE
1549 > Choose the right operating system.
1550 When logged in, <SPAN
1554 >make sure that you have freshly exported the right
1555 version into an empty directory</I
1557 >. (See "Building and releasing
1558 packages" above). Then run:
1568 CLASS="PROGRAMLISTING"
1570 autoheader && autoconf && ./configure</PRE
1587 CLASS="PROGRAMLISTING"
1588 > make aix-dist</PRE
1595 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1599 > on the Sourceforge machine (no ncftpput). You now have
1600 to manually upload the archive to Sourceforge's ftp server and release
1601 the file publicly. Use the release notes and Change Log from the
1602 source tarball package.
1611 NAME="RELEASING">6.4. Uploading and Releasing Your Package</H2
1613 > After the package is ready, it is time to upload it
1614 to SourceForge, and go through the release steps. The upload
1624 HREF="ftp://upload.sourceforge.net/incoming"
1626 >ftp://upload.sourceforge.net/incoming</A
1642 >ijbswa-developers@lists.sourceforge.net</TT
1653 > targets as described above.
1656 > Once this done go to <A
1657 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1659 >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1661 making sure you are logged in. Find your target platform in the
1662 second column, and click <TT
1666 then need to create a new release for your package, using the format
1669 >$VERSION ($CODE_STATUS)</TT
1680 > Now just follow the prompts. Be sure to add any appropriate Release
1681 notes. You should see your freshly uploaded packages in
1684 >"Step 2. Add Files To This Release"</SPAN
1686 appropriate box(es). Remember at each step to hit the
1689 >"Refresh/Submit"</SPAN
1690 > buttons! You should now see your
1691 file(s) listed in Step 3. Fill out the forms with the appropriate
1692 information for your platform, being sure to hit <SPAN
1696 for each file. If anyone is monitoring your platform, check the
1700 > box at the very bottom to notify them of
1701 the new package. This should do it!
1704 > If you have made errors, or need to make changes, you can go through
1705 essentially the same steps, but select <TT
1720 NAME="AFTERRELEASE">6.5. After the Release</H2
1722 > When all (or: most of the) packages have been uploaded and made available,
1723 send an email to the <A
1724 HREF="mailto:ijbswa-announce@lists.sourceforge.net"
1728 >, Subject: "Version X.Y.Z available for download". Be sure to
1731 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
1735 >, the release notes and the Changelog. Also, post an
1736 updated News item on the project page Sourceforge, and update the Home
1737 page and docs linked from the Home page (see below).
1746 SUMMARY="Footer navigation table"
1775 HREF="webserver-update.html"
1785 >Testing Guidelines</TD
1795 >Update the Webserver</TD