4 >Releasing a New Version</TITLE
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.60"><LINK
9 TITLE="Privoxy Developer Manual"
10 HREF="index.html"><LINK
12 TITLE="Testing Guidelines"
13 HREF="testing.html"><LINK
15 TITLE="Update the Webserver"
16 HREF="webserver-update.html"><LINK
19 HREF="../p_doc.css"></HEAD
38 >Privoxy Developer Manual</TH
59 HREF="webserver-update.html"
73 >6. Releasing a New Version</A
76 > When we release versions of <SPAN
80 our work leaves our cozy secret lab and has to work in the cold
81 RealWorld[tm]. Once it is released, there is no way to call it
82 back, so it is very important that great care is taken to ensure
83 that everything runs fine, and not to introduce problems in the
87 > So when releasing a new version, please adhere exactly to the
88 procedure outlined in this chapter.
91 > The following programs are required to follow this process:
102 > (GNU's version of make), autoconf, cvs.
109 NAME="VERSIONNUMBERS"
110 >6.1. Version numbers</A
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.
179 >6.2. Before the Release: Freeze</A
184 >must be done by one of the
186 > prior to each new release.
194 > Make sure that everybody who has worked on the code in the last
195 couple of days has had a chance to yell <SPAN
199 they have pending changes/fixes in their pipelines. Announce the
200 freeze so that nobody will interfere with last minute changes.
205 > Increment the version number (point from odd to even in development
217 > has changed since last
218 release (i.e. software release or standalone actions file release),
219 bump up its version info to A.B in this line:
230 CLASS="PROGRAMLISTING"
231 > {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}</PRE
239 Then change the version info in doc/webserver/actions/index.php,
240 line: '$required_actions_file_version = "A.B";'
245 > If the HTML documentation is not in sync with the SGML sources
246 you need to regenerate and upload it to the webserver. (If in
247 doubt, just do it.) See the Section "Updating the webserver" in
248 this manual for details.
255 >Commit all files that were changed in the above steps!</I
261 > Tag all files in CVS with the version number with
269 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
274 > If the release was in a development branch, increase the point version
275 from even to odd (X.Y.(Z+1)) again in <TT
284 > On the webserver, copy the user manual to a new top-level directory
288 >. This ensures that help links from the CGI
289 pages, which have the version as a prefix, will go into the right version of the manual.
290 If this is a development branch release, also symlink <TT
317 >6.3. Building and Releasing the Packages</A
320 > Now the individual packages can be built and released. Note that for
321 GPL reasons the first package to be released is always the source tarball.
327 > types of packages, including the source tarball,
330 >you must make sure that you build from clean sources by exporting
331 the right version from CVS into an empty directory:</I
342 CLASS="PROGRAMLISTING"
343 > mkdir dist # delete or choose different name if it already exists
345 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
346 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
356 > a single bit, including, but not limited to
357 version information after export from CVS. This is to make sure that
358 all release packages, and with them, all future bug reports, are based
359 on exactly the same code.
362 > Please find additional instructions for the source tarball and the
363 individual platform dependent binary packages below. And details
364 on the Sourceforge release process below that.
371 NAME="PACK-GUIDELINES"
372 >6.3.1. Note on Privoxy Packaging</A
375 > Please keep these general guidelines in mind when putting together
376 your package. These apply to <I
394 write access to: all <TT
398 logfiles, and the <TT
402 need to determine the best way to do this for your platform.
407 > Please include up to date documentation. At a bare minimum:
419 > (top-level directory)
436 > (top-level directory)
453 > (top-level directory)
470 > (top-level directory, Unix-like
488 > (doc/webserver/user-manual/)
505 > (doc/webserver/faq/)
513 > Also suggested: <TT
515 >Developer Manual</TT
517 (doc/webserver/developer-manual) and <TT
521 (top-level directory). <TT
524 > and the manuals are
525 HTML docs. There are also text versions in
529 > which could conceivably also be
533 > The documentation has been designed such that the manuals are linked
534 to each other from parallel directories, and should be packaged
537 >privoxy-index.html</TT
539 included and can serve as a focal point for docs and other links of
540 interest (and possibly renamed to <TT
544 This should be one level up from the manuals. There is a link also
545 on this page to an HTMLized version of the man page. To avoid 404 for
546 this, it is in CVS as
549 >doc/webserver/man-page/privoxy-man-page.html</TT
551 and should be included along with the manuals. There is also a
552 css stylesheets that can be included for better presentation:
556 >. This should be in the same directory
559 >privoxy-index.html</TT
560 >, (i.e. one level up from
561 the manual directories).
569 > is designed for local preferences.
570 Make sure this does not get overwritten!
575 > Other configuration files should be installed as the new defaults,
576 but all previously installed configuration files should be preserved
577 as backups. This is just good manners :-)
582 > Please check platform specific notes in this doc, if you haven't
586 > packaging before for other platform
587 specific issues. Conversely, please add any notes that you know
588 are important for your platform (or contact one of the doc
589 maintainers to do this if you can't).
601 NAME="NEWRELEASE-TARBALL"
602 >6.3.2. Source Tarball</A
607 >make sure that you have freshly exported the right
608 version into an empty directory</I
609 >. (See "Building and releasing
610 packages" above). Then run:
620 CLASS="PROGRAMLISTING"
622 autoheader && autoconf && ./configure</PRE
639 CLASS="PROGRAMLISTING"
640 > make tarball-dist</PRE
647 > To upload the package to Sourceforge, simply issue
657 CLASS="PROGRAMLISTING"
658 > make tarball-upload</PRE
665 > Go to the displayed URL and release the file publicly on Sourceforge.
666 For the change log field, use the relevant section of the
678 NAME="NEWRELEASE-RPM"
679 >6.3.3. SuSE, Conectiva or Red Hat RPM</A
682 > In following text, replace <TT
691 > for Red Hat or <SPAN
699 >make sure that you have freshly exported the right
700 version into an empty directory</I
701 >. (See "Building and releasing
705 > As the only exception to not changing anything after export from CVS,
706 now examine the file <TT
718 and make sure that the version information and the RPM release number are
719 correct. The RPM release numbers for each version start at one. Hence it must
720 be reset to one if this is the first RPM for
726 > which is built from version
729 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
733 > if unsure. Else, it must be set to the highest already available RPM
734 release number for that version plus one.
747 CLASS="PROGRAMLISTING"
749 autoheader && autoconf && ./configure</PRE
766 CLASS="PROGRAMLISTING"
779 > To upload the package to Sourceforge, simply issue
789 CLASS="PROGRAMLISTING"
813 RPM release number as determined above.
814 Go to the displayed URL and release the file publicly on Sourceforge.
815 Use the release notes and change log from the source tarball package.
823 NAME="NEWRELEASE-OS2"
829 >make sure that you have freshly exported the right
830 version into an empty directory</I
831 >. (See "Building and releasing
832 packages" above). Then get the OS/2 Setup module:
842 CLASS="PROGRAMLISTING"
843 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
850 > You will need a mix of development tools.
851 The main compilation takes place with IBM Visual Age C++.
852 Some ancillary work takes place with GNU tools, available from
853 various sources like hobbes.nmsu.edu.
854 Specificially, you will need <TT
865 The packaging takes place with WarpIN, available from various sources, including
867 HREF="http://www.xworkplace.org/"
873 > Change directory to the <TT
877 Edit the os2build.cmd file to set the final executable filename.
888 CLASS="PROGRAMLISTING"
889 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
899 > file so the release number matches
913 CLASS="PROGRAMLISTING"
914 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
921 > You're now ready to build. Run:
931 CLASS="PROGRAMLISTING"
939 > You will find the WarpIN-installable executable in the
943 > directory. Upload this anonymously to
946 >uploads.sourceforge.net/incoming</TT
948 for it, and you're done. Use the release notes and Change Log from the
949 source tarball package.
957 NAME="NEWRELEASE-SOLARIS"
961 > Login to Sourceforge's compilefarm via ssh:
971 CLASS="PROGRAMLISTING"
972 > ssh cf.sourceforge.net</PRE
979 > Choose the right operating system (not the Debian one).
982 >make sure that you have freshly exported the right
983 version into an empty directory</I
984 >. (See "Building and releasing
985 packages" above). Then run:
995 CLASS="PROGRAMLISTING"
997 autoheader && autoconf && ./configure</PRE
1014 CLASS="PROGRAMLISTING"
1015 > gmake solaris-dist</PRE
1022 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1026 > on the Sourceforge machine (no ncftpput). You now have
1027 to manually upload the archive to Sourceforge's ftp server and release
1028 the file publicly. Use the release notes and Change Log from the
1029 source tarball package.
1037 NAME="NEWRELEASE-WINDOWS"
1041 > You should ensure you have the latest version of Cygwin (from
1043 HREF="http://www.cygwin.com/"
1045 >http://www.cygwin.com/</A
1047 Run the following commands from within a Cygwin bash shell.
1052 >make sure that you have freshly exported the right
1053 version into an empty directory</I
1054 >. (See "Building and releasing
1055 packages" above). Then get the Windows setup module:
1065 CLASS="PROGRAMLISTING"
1066 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1073 > Then you can build the package. This is fully automated, and is
1076 >winsetup/GNUmakefile</TT
1078 All you need to do is:
1088 CLASS="PROGRAMLISTING"
1097 > Now you can manually rename <TT
1099 >privoxy_setup.exe</TT
1103 >privoxy_setup_X_Y_Z.exe</TT
1105 SourceForge. When releasing the package on SourceForge, use the release notes
1106 and Change Log from the source tarball package.
1114 NAME="NEWRELEASE-DEBIAN"
1120 >make sure that you have freshly exported the
1121 right version into an empty directory</I
1123 "Building and releasing packages" above). Then add a log
1126 >debian/changelog</TT
1128 already there, for example by running:
1138 CLASS="PROGRAMLISTING"
1139 > debchange -v 2.9.18-beta-1 "New upstream version"</PRE
1156 CLASS="PROGRAMLISTING"
1157 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1167 >../privoxy_2.9.18-beta-1_i386.deb</TT
1169 which can be uploaded. To upload the package to Sourceforge, simply
1180 CLASS="PROGRAMLISTING"
1181 > make debian-upload</PRE
1193 NAME="NEWRELEASE-MACOSX"
1199 >make sure that you have freshly exported the right
1200 version into an empty directory</I
1201 >. (See "Building and releasing
1202 packages" above). Then get the Mac OSX setup module:
1212 CLASS="PROGRAMLISTING"
1213 > cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1230 CLASS="PROGRAMLISTING"
1253 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1254 for further processing by <TT
1260 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1261 name to match the release, and hit the "Create package" button.
1262 If you specify ./Privoxy.pkg as the output package name, you can then create
1263 the distributable zip file with the command:
1273 CLASS="PROGRAMLISTING"
1274 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1281 > You can then upload <TT
1283 >privoxyosx_setup_x.y.z.zip</TT
1287 >uploads.sourceforge.net/incoming</TT
1289 create a release for it, and you're done. Use the release notes
1290 and Change Log from the source tarball package.
1298 NAME="NEWRELEASE-FREEBSD"
1302 > Login to Sourceforge's compile-farm via ssh:
1312 CLASS="PROGRAMLISTING"
1313 > ssh cf.sourceforge.net</PRE
1320 > Choose the right operating system.
1323 >make sure that you have freshly exported the right
1324 version into an empty directory</I
1325 >. (See "Building and releasing
1326 packages" above). Then run:
1336 CLASS="PROGRAMLISTING"
1338 autoheader && autoconf && ./configure</PRE
1355 CLASS="PROGRAMLISTING"
1356 > gmake freebsd-dist</PRE
1363 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1367 > on the Sourceforge machine (no ncftpput). You now have
1368 to manually upload the archive to Sourceforge's ftp server and release
1369 the file publicly. Use the release notes and Change Log from the
1370 source tarball package.
1378 NAME="NEWRELEASE-HPUX"
1379 >6.3.10. HP-UX 11</A
1384 >make sure that you have freshly exported the right
1385 version into an empty directory</I
1386 >. (See "Building and releasing
1387 packages" above). Then run:
1397 CLASS="PROGRAMLISTING"
1399 autoheader && autoconf && ./configure</PRE
1414 NAME="NEWRELEASE-AMIGA"
1415 >6.3.11. Amiga OS</A
1420 >make sure that you have freshly exported the right
1421 version into an empty directory</I
1422 >. (See "Building and releasing
1423 packages" above). Then run:
1433 CLASS="PROGRAMLISTING"
1435 autoheader && autoconf && ./configure</PRE
1450 NAME="NEWRELEASE-AIX"
1454 > Login to Sourceforge's compilefarm via ssh:
1464 CLASS="PROGRAMLISTING"
1465 > ssh cf.sourceforge.net</PRE
1472 > Choose the right operating system.
1475 >make sure that you have freshly exported the right
1476 version into an empty directory</I
1477 >. (See "Building and releasing
1478 packages" above). Then run:
1488 CLASS="PROGRAMLISTING"
1490 autoheader && autoconf && ./configure</PRE
1507 CLASS="PROGRAMLISTING"
1508 > make aix-dist</PRE
1515 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1519 > on the Sourceforge machine (no ncftpput). You now have
1520 to manually upload the archive to Sourceforge's ftp server and release
1521 the file publicly. Use the release notes and Change Log from the
1522 source tarball package.
1532 >6.4. Uploading and Releasing Your Package</A
1535 > After the package is ready, it is time to upload it
1536 to SourceForge, and go through the release steps. The upload
1546 HREF="ftp://upload.sourceforge.net/incoming"
1548 >ftp://upload.sourceforge.net/incoming</A
1564 >ijbswa-developers@lists.sourceforge.net</TT
1575 > targets as described above.
1578 > Once this done go to <A
1579 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1581 >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1583 making sure you are logged in. Find your target platform in the
1584 second column, and click <TT
1588 then need to create a new release for your package, using the format
1591 >$VERSION ($CODE_STATUS)</TT
1599 > Now just follow the prompts. Be sure to add any appropriate Release
1600 notes. You should see your freshly uploaded packages in
1603 >"Step 2. Add Files To This Release"</SPAN
1605 appropriate box(es). Remember at each step to hit the
1608 >"Refresh/Submit"</SPAN
1609 > buttons! You should now see your
1610 file(s) listed in Step 3. Fill out the forms with the appropriate
1611 information for your platform, being sure to hit <SPAN
1615 for each file. If anyone is monitoring your platform, check the
1619 > box at the very bottom to notify them of
1620 the new package. This should do it!
1623 > If you have made errors, or need to make changes, you can go through
1624 essentially the same steps, but select <TT
1640 >6.5. After the Release</A
1643 > When all (or: most of the) packages have been uploaded and made available,
1644 send an email to the <A
1645 HREF="mailto:ijbswa-announce@lists.sourceforge.net"
1649 >, Subject: "Version X.Y.Z available for download". Be sure to
1652 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
1656 >, the release notes and the change log.
1691 HREF="webserver-update.html"
1700 >Testing Guidelines</TD
1710 >Update the Webserver</TD