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
218 > has changed since last
219 release (i.e. software release or standalone actions file release),
220 bump up its version info to A.B in this line:
231 CLASS="PROGRAMLISTING"
232 > {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}</PRE
240 Then change the version info in doc/webserver/actions/index.php,
241 line: '$required_actions_file_version = "A.B";'
246 > If the HTML documentation is not in sync with the SGML sources
247 you need to regenerate and upload it to the webserver. (If in
248 doubt, just do it.) See the Section "Updating the webserver" in
249 this manual for details.
258 >Commit all files that were changed in the above steps!</I
265 > Tag all files in CVS with the version number with
273 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
278 > If the release was in a development branch, increase the point version
279 from even to odd (X.Y.(Z+1)) again in <TT
288 > On the webserver, copy the user manual to a new top-level directory
292 >. This ensures that help links from the CGI
293 pages, which have the version as a prefix, will go into the right version of the manual.
294 If this is a development branch release, also symlink <TT
320 NAME="THERELEASE">6.3. Building and Releasing the Packages</H2
322 > Now the individual packages can be built and released. Note that for
323 GPL reasons the first package to be released is always the source tarball.
332 > types of packages, including the source tarball,
337 >you must make sure that you build from clean sources by exporting
338 the right version from CVS into an empty directory:</I
350 CLASS="PROGRAMLISTING"
351 > mkdir dist # delete or choose different name if it already exists
353 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
354 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
367 > a single bit, including, but not limited to
368 version information after export from CVS. This is to make sure that
369 all release packages, and with them, all future bug reports, are based
370 on exactly the same code.
373 > Please find additional instructions for the source tarball and the
374 individual platform dependent binary packages below. And details
375 on the Sourceforge release process below that.
382 NAME="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</H3
384 > Please keep these general guidelines in mind when putting together
385 your package. These apply to <SPAN
409 write access to: all <TT
413 logfiles, and the <TT
417 need to determine the best way to do this for your platform.
422 > Please include up to date documentation. At a bare minimum:
434 > (top-level directory)
451 > (top-level directory)
468 > (top-level directory)
485 > (top-level directory, Unix-like
503 > (doc/webserver/user-manual/)
520 > (doc/webserver/faq/)
528 > Also suggested: <TT
530 >Developer Manual</TT
532 (doc/webserver/developer-manual) and <TT
536 (top-level directory). <TT
539 > and the manuals are
540 HTML docs. There are also text versions in
544 > which could conceivably also be
548 > The documentation has been designed such that the manuals are linked
549 to each other from parallel directories, and should be packaged
552 >privoxy-index.html</TT
554 included and can serve as a focal point for docs and other links of
555 interest (and possibly renamed to <TT
559 This should be one level up from the manuals. There is a link also
560 on this page to an HTMLized version of the man page. To avoid 404 for
561 this, it is in CVS as
564 >doc/webserver/man-page/privoxy-man-page.html</TT
566 and should be included along with the manuals. There is also a
567 css stylesheets that can be included for better presentation:
571 >. This should be in the same directory
574 >privoxy-index.html</TT
575 >, (i.e. one level up from
576 the manual directories).
584 > is designed for local preferences.
585 Make sure this does not get overwritten!
590 > Other configuration files should be installed as the new defaults,
591 but all previously installed configuration files should be preserved
592 as backups. This is just good manners :-)
597 > Please check platform specific notes in this doc, if you haven't
601 > packaging before for other platform
602 specific issues. Conversely, please add any notes that you know
603 are important for your platform (or contact one of the doc
604 maintainers to do this if you can't).
616 NAME="NEWRELEASE-TARBALL">6.3.2. Source Tarball</H3
622 >make sure that you have freshly exported the right
623 version into an empty directory</I
625 >. (See "Building and releasing
626 packages" above). Then run:
636 CLASS="PROGRAMLISTING"
638 autoheader && autoconf && ./configure</PRE
655 CLASS="PROGRAMLISTING"
656 > make tarball-dist</PRE
663 > To upload the package to Sourceforge, simply issue
673 CLASS="PROGRAMLISTING"
674 > make tarball-upload</PRE
681 > Go to the displayed URL and release the file publicly on Sourceforge.
682 For the change log field, use the relevant section of the
694 NAME="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</H3
696 > In following text, replace <TT
705 > for Red Hat or <SPAN
715 >make sure that you have freshly exported the right
716 version into an empty directory</I
718 >. (See "Building and releasing
722 > As the only exception to not changing anything after export from CVS,
723 now examine the file <TT
735 and make sure that the version information and the RPM release number are
736 correct. The RPM release numbers for each version start at one. Hence it must
737 be reset to one if this is the first RPM for
743 > which is built from version
746 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
750 > if unsure. Else, it must be set to the highest already available RPM
751 release number for that version plus one.
764 CLASS="PROGRAMLISTING"
766 autoheader && autoconf && ./configure</PRE
783 CLASS="PROGRAMLISTING"
796 > To upload the package to Sourceforge, simply issue
806 CLASS="PROGRAMLISTING"
830 RPM release number as determined above.
831 Go to the displayed URL and release the file publicly on Sourceforge.
832 Use the release notes and change log from the source tarball package.
840 NAME="NEWRELEASE-OS2">6.3.4. OS/2</H3
846 >make sure that you have freshly exported the right
847 version into an empty directory</I
849 >. (See "Building and releasing
850 packages" above). Then get the OS/2 Setup module:
860 CLASS="PROGRAMLISTING"
861 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
868 > You will need a mix of development tools.
869 The main compilation takes place with IBM Visual Age C++.
870 Some ancillary work takes place with GNU tools, available from
871 various sources like hobbes.nmsu.edu.
872 Specificially, you will need <TT
883 The packaging takes place with WarpIN, available from various sources, including
885 HREF="http://www.xworkplace.org/"
891 > Change directory to the <TT
895 Edit the os2build.cmd file to set the final executable filename.
906 CLASS="PROGRAMLISTING"
907 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
917 > file so the release number matches
931 CLASS="PROGRAMLISTING"
932 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
939 > You're now ready to build. Run:
949 CLASS="PROGRAMLISTING"
957 > You will find the WarpIN-installable executable in the
961 > directory. Upload this anonymously to
964 >uploads.sourceforge.net/incoming</TT
966 for it, and you're done. Use the release notes and Change Log from the
967 source tarball package.
975 NAME="NEWRELEASE-SOLARIS">6.3.5. Solaris</H3
977 > Login to Sourceforge's compilefarm via ssh:
987 CLASS="PROGRAMLISTING"
988 > ssh cf.sourceforge.net</PRE
995 > Choose the right operating system (not the Debian one).
996 When logged in, <SPAN
1000 >make sure that you have freshly exported the right
1001 version into an empty directory</I
1003 >. (See "Building and releasing
1004 packages" above). Then run:
1014 CLASS="PROGRAMLISTING"
1016 autoheader && autoconf && ./configure</PRE
1033 CLASS="PROGRAMLISTING"
1034 > gmake solaris-dist</PRE
1041 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1045 > on the Sourceforge machine (no ncftpput). You now have
1046 to manually upload the archive to Sourceforge's ftp server and release
1047 the file publicly. Use the release notes and Change Log from the
1048 source tarball package.
1056 NAME="NEWRELEASE-WINDOWS">6.3.6. Windows</H3
1058 > You should ensure you have the latest version of Cygwin (from
1060 HREF="http://www.cygwin.com/"
1062 >http://www.cygwin.com/</A
1064 Run the following commands from within a Cygwin bash shell.
1071 >make sure that you have freshly exported the right
1072 version into an empty directory</I
1074 >. (See "Building and releasing
1075 packages" above). Then get the Windows setup module:
1085 CLASS="PROGRAMLISTING"
1086 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1093 > Then you can build the package. This is fully automated, and is
1096 >winsetup/GNUmakefile</TT
1098 All you need to do is:
1108 CLASS="PROGRAMLISTING"
1117 > Now you can manually rename <TT
1119 >privoxy_setup.exe</TT
1123 >privoxy_setup_X_Y_Z.exe</TT
1125 SourceForge. When releasing the package on SourceForge, use the release notes
1126 and Change Log from the source tarball package.
1134 NAME="NEWRELEASE-DEBIAN">6.3.7. Debian</H3
1140 >make sure that you have freshly exported the
1141 right version into an empty directory</I
1144 "Building and releasing packages" above). Then add a log
1147 >debian/changelog</TT
1149 already there, for example by running:
1159 CLASS="PROGRAMLISTING"
1160 > debchange -v 2.9.15-beta-1 "New upstream version"</PRE
1177 CLASS="PROGRAMLISTING"
1178 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1188 >../privoxy_2.9.15-beta-1_i386.deb</TT
1190 which can be uploaded. To upload the package to Sourceforge, simply
1201 CLASS="PROGRAMLISTING"
1202 > make debian-upload</PRE
1214 NAME="NEWRELEASE-MACOSX">6.3.8. Mac OSX</H3
1220 >make sure that you have freshly exported the right
1221 version into an empty directory</I
1223 >. (See "Building and releasing
1224 packages" above). Then get the Mac OSX setup module:
1234 CLASS="PROGRAMLISTING"
1235 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1252 CLASS="PROGRAMLISTING"
1275 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1276 for further processing by <TT
1282 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1283 name to match the release, and hit the "Create package" button.
1284 If you specify ./Privoxy.pkg as the output package name, you can then create
1285 the distributable zip file with the command:
1295 CLASS="PROGRAMLISTING"
1296 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1303 > You can then upload <TT
1305 >privoxyosx_setup_x.y.z.zip</TT
1309 >uploads.sourceforge.net/incoming</TT
1311 create a release for it, and you're done. Use the release notes
1312 and Change Log from the source tarball package.
1320 NAME="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</H3
1322 > Login to Sourceforge's compile-farm via ssh:
1332 CLASS="PROGRAMLISTING"
1333 > ssh cf.sourceforge.net</PRE
1340 > Choose the right operating system.
1341 When logged in, <SPAN
1345 >make sure that you have freshly exported the right
1346 version into an empty directory</I
1348 >. (See "Building and releasing
1349 packages" above). Then run:
1359 CLASS="PROGRAMLISTING"
1361 autoheader && autoconf && ./configure</PRE
1378 CLASS="PROGRAMLISTING"
1379 > gmake freebsd-dist</PRE
1386 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1390 > on the Sourceforge machine (no ncftpput). You now have
1391 to manually upload the archive to Sourceforge's ftp server and release
1392 the file publicly. Use the release notes and Change Log from the
1393 source tarball package.
1401 NAME="NEWRELEASE-HPUX">6.3.10. HP-UX 11</H3
1407 >make sure that you have freshly exported the right
1408 version into an empty directory</I
1410 >. (See "Building and releasing
1411 packages" above). Then run:
1421 CLASS="PROGRAMLISTING"
1423 autoheader && autoconf && ./configure</PRE
1438 NAME="NEWRELEASE-AMIGA">6.3.11. Amiga OS</H3
1444 >make sure that you have freshly exported the right
1445 version into an empty directory</I
1447 >. (See "Building and releasing
1448 packages" above). Then run:
1458 CLASS="PROGRAMLISTING"
1460 autoheader && autoconf && ./configure</PRE
1475 NAME="NEWRELEASE-AIX">6.3.12. AIX</H3
1477 > Login to Sourceforge's compilefarm via ssh:
1487 CLASS="PROGRAMLISTING"
1488 > ssh cf.sourceforge.net</PRE
1495 > Choose the right operating system.
1496 When logged in, <SPAN
1500 >make sure that you have freshly exported the right
1501 version into an empty directory</I
1503 >. (See "Building and releasing
1504 packages" above). Then run:
1514 CLASS="PROGRAMLISTING"
1516 autoheader && autoconf && ./configure</PRE
1533 CLASS="PROGRAMLISTING"
1534 > make aix-dist</PRE
1541 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1545 > on the Sourceforge machine (no ncftpput). You now have
1546 to manually upload the archive to Sourceforge's ftp server and release
1547 the file publicly. Use the release notes and Change Log from the
1548 source tarball package.
1557 NAME="RELEASING">6.4. Uploading and Releasing Your Package</H2
1559 > After the package is ready, it is time to upload it
1560 to SourceForge, and go through the release steps. The upload
1570 HREF="ftp://upload.sourceforge.net/incoming"
1572 >ftp://upload.sourceforge.net/incoming</A
1588 >ijbswa-developers@lists.sourceforge.net</TT
1599 > targets as described above.
1602 > Once this done go to <A
1603 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1605 >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1607 making sure you are logged in. Find your target platform in the
1608 second column, and click <TT
1612 then need to create a new release for your package, using the format
1615 >$VERSION ($CODE_STATUS)</TT
1626 > Now just follow the prompts. Be sure to add any appropriate Release
1627 notes. You should see your freshly uploaded packages in
1630 >"Step 2. Add Files To This Release"</SPAN
1632 appropriate box(es). Remember at each step to hit the
1635 >"Refresh/Submit"</SPAN
1636 > buttons! You should now see your
1637 file(s) listed in Step 3. Fill out the forms with the appropriate
1638 information for your platform, being sure to hit <SPAN
1642 for each file. If anyone is monitoring your platform, check the
1646 > box at the very bottom to notify them of
1647 the new package. This should do it!
1650 > If you have made errors, or need to make changes, you can go through
1651 essentially the same steps, but select <TT
1666 NAME="AFTERRELEASE">6.5. After the Release</H2
1668 > When all (or: most of the) packages have been uploaded and made available,
1669 send an email to the <A
1670 HREF="mailto:ijbswa-announce@lists.sourceforge.net"
1674 >, Subject: "Version X.Y.Z available for download". Be sure to
1677 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
1681 >, the release notes and the change log.
1690 SUMMARY="Footer navigation table"
1719 HREF="webserver-update.html"
1729 >Testing Guidelines</TD
1739 >Update the Webserver</TD