1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
5 >Releasing a New Version</TITLE
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
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"><META
21 HTTP-EQUIV="Content-Type"
23 charset=ISO-8859-1"></HEAD
34 SUMMARY="Header navigation table"
43 >Privoxy Developer Manual</TH
65 HREF="webserver-update.html"
80 >6. Releasing a New Version</A
83 > When we release versions of <SPAN
87 our work leaves our cozy secret lab and has to work in the cold
88 RealWorld[tm]. Once it is released, there is no way to call it
89 back, so it is very important that great care is taken to ensure
90 that everything runs fine, and not to introduce problems in the
94 > So when releasing a new version, please adhere exactly to the
95 procedure outlined in this chapter.
98 > The following programs are required to follow this process:
109 > (GNU's version of make), autoconf, cvs.
116 NAME="VERSIONNUMBERS"
117 >6.1. Version numbers</A
120 > First you need to determine which version number the release will have.
124 > version numbers consist of three numbers,
125 separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
132 > X, the version major, is rarely ever changed. It is increased by one if
133 turning a development branch into stable substantially changes the functionality,
134 user interface or configuration syntax. Majors 1 and 2 were
138 >, and 3 will be the first stable
147 > Y, the version minor, represents the branch within the major version.
148 At any point in time, there are two branches being maintained:
149 The stable branch, with an even minor, say, 2N, in which no functionality is
150 being added and only bug-fixes are made, and 2N+1, the development branch, in
151 which the further development of <SPAN
156 This enables us to turn the code upside down and inside out, while at the same time
157 providing and maintaining a stable version.
158 The minor is reset to zero (and one) when the major is incremented. When a development
159 branch has matured to the point where it can be turned into stable, the old stable branch
160 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
161 new stable branch 2N+2, and a new development branch 2N+3 is opened.
166 > Z, the point or sub version, represents a release of the software within a branch.
167 It is therefore incremented immediately before each code freeze.
168 In development branches, only the even point versions correspond to actual releases,
169 while the odd ones denote the evolving state of the sources on Git in between.
170 It follows that Z is odd on Git in development branches most of the time. There, it gets
171 increased to an even number immediately before a code freeze, and is increased to an odd
172 number again immediately thereafter.
173 This ensures that builds from Git snapshots are easily distinguished from released versions.
174 The point version is reset to zero when the minor changes.
177 > Stable branches work a little differently, since there should be
178 little to no development happening in such branches. Remember,
179 only bugfixes, which presumably should have had some testing
180 before being committed. Stable branches will then have their
181 version reported as <TT
184 >, during that period
185 between releases when changes are being added. This is to denote
186 that this code is <SPAN
193 as the release nears, the version is bumped according: e.g.
196 >3.0.1 -> 0.0.0 -> 3.0.2</TT
202 > In summary, the main Git trunk is the development branch where new
203 features are being worked on for the next stable series. This should
204 almost always be where the most activity takes place. There is always at
205 least one stable branch from the trunk, e.g now it is
209 >, which is only used to release stable versions.
210 Once the initial *.0 release of the stable branch has been done, then as a
211 rule, only bugfixes that have had prior testing should be committed to
212 the stable branch. Once there are enough bugfixes to justify a new
213 release, the version of this branch is again incremented Example: 3.0.0
214 -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
215 branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
216 taking place. If any questions, please post to the devel list
223 > committing to a stable branch!
226 > Developers should remember too that if they commit a bugfix to the stable
227 branch, this will more than likely require a separate submission to the
228 main trunk, since these are separate development trees within Git. If you
229 are working on both, then this would require at least two separate check
230 outs (i.e main trunk, <SPAN
236 > the stable release branch,
249 >6.2. Before the Release: Freeze</A
252 > The following <SPAN
256 >must be done by one of the
259 > prior to each new release.
266 > Make sure that everybody who has worked on the code in the last
267 couple of days has had a chance to yell <SPAN
271 they have pending changes/fixes in their pipelines. Announce the
272 freeze so that nobody will interfere with last minute changes.
277 > Increment the version number (point from odd to even in development
281 > and update the code
282 status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable".
283 Rebuild configure and GNUMakefile to make sure the updated values are
289 > Use the dok-release target to update the sgml documentation source files.
294 > If action file processing has changed and is not backward-compatible,
295 make sure the "for-privoxy-version=x.y.z" minimum version number in
296 default.action.master has been updated:
305 CLASS="PROGRAMLISTING"
307 #############################################################################
308 #MASTER# COMMENT: The minimum Privoxy version:
309 for-privoxy-version=3.0.11</PRE
316 > All documentation should be rebuild after the version bump.
317 Finished docs should be then be committed to Git (for those
318 without the ability to build these). Some docs may require
319 rather obscure processing tools. <TT
323 the man page (and the html version of the man page)
324 fall in this category. README, the man page, AUTHORS, and config
325 should all also be committed to Git for other packagers. The
326 formal docs should be uploaded to the webserver. See the
327 Section "Updating the webserver" in this manual for details.
335 > is also used for context
336 sensitive help for the CGI editor. This is version sensitive, so that
337 the user will get appropriate help for his/her release. So with
338 each release a fresh version should be uploaded to the webserver
339 (this is in addition to the main <I
343 link from the main page since we need to keep manuals for various
344 versions available). The CGI pages will link to something like
347 >http://privoxy.org/$(VERSION)/user-manual/</TT
349 will need to be updated for each new release. There is no Makefile
350 target for this at this time!!! It needs to be done manually.
355 > All developers should look at the <TT
359 make sure noteworthy changes are referenced.
368 >Commit all files that were changed in the above steps!</I
375 > Tag all files in Git with the version number with
383 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
388 > If the release was in a development branch, increase the point version
389 from even to odd (X.Y.(Z+1)) again in <TT
398 > On the webserver, copy the user manual to a new top-level directory
402 >. This ensures that help links from the CGI
403 pages, which have the version as a prefix, will go into the right version of the manual.
404 If this is a development branch release, also symlink <TT
429 >6.3. Building and Releasing the Packages</A
432 > Now the individual packages can be built and released. Note that for
433 GPL reasons the first package to be released is always the source tarball.
442 > types of packages, including the source tarball,
447 >you must make sure that you build from clean sources by exporting
448 the right version from Git into an empty directory</I
450 > (just press return when
451 asked for a password):
460 CLASS="PROGRAMLISTING"
461 > mkdir dist # delete or choose different name if it already exists
463 cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
464 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</PRE
475 > a single bit, including, but not limited to
476 version information after export from Git. This is to make sure that
477 all release packages, and with them, all future bug reports, are based
478 on exactly the same code.
499 > Every significant release of Privoxy has included at least one
500 package that either had incorrect versions of files, missing files,
501 or incidental leftovers from a previous build process that gave
502 unknown numbers of users headaches to try to figure out what was
503 wrong. PLEASE, make sure you are using pristene sources, and are
504 following the prescribed process!
511 > Please find additional instructions for the source tarball and the
512 individual platform dependent binary packages below. And details
513 on the Sourceforge release process below that.
520 NAME="PACK-GUIDELINES"
521 >6.3.1. Note on Privoxy Packaging</A
524 > Please keep these general guidelines in mind when putting together
525 your package. These apply to <SPAN
548 write access to: all <TT
552 logfiles, and the <TT
556 need to determine the best way to do this for your platform.
561 > Please include up to date documentation. At a bare minimum:
573 > (top-level directory)
590 > (top-level directory)
607 > (top-level directory)
624 > (top-level directory, Unix-like
642 > (doc/webserver/user-manual/)
659 > (doc/webserver/faq/)
667 > Also suggested: <TT
669 >Developer Manual</TT
671 (doc/webserver/developer-manual) and <TT
675 (top-level directory). <TT
678 > and the manuals are
679 HTML docs. There are also text versions in
683 > which could conceivably also be
687 > The documentation has been designed such that the manuals are linked
688 to each other from parallel directories, and should be packaged
691 >privoxy-index.html</TT
693 included and can serve as a focal point for docs and other links of
694 interest (and possibly renamed to <TT
698 This should be one level up from the manuals. There is a link also
699 on this page to an HTMLized version of the man page. To avoid 404 for
700 this, it is in Git as
703 >doc/webserver/man-page/privoxy-man-page.html</TT
705 and should be included along with the manuals. There is also a
706 css stylesheets that can be included for better presentation:
710 >. This should be in the same directory
713 >privoxy-index.html</TT
714 >, (i.e. one level up from
715 the manual directories).
727 are designed for local preferences. Make sure these do not get overwritten!
731 > should not be overwritten either. This
732 has especially important configuration data in it.
736 > should be left in tact as well.
741 > Other configuration files (<TT
748 >) should be installed as the new
749 defaults, but all previously installed configuration files should be
750 preserved as backups. This is just good manners :-) These files are
751 likely to change between releases and contain important new features
757 > Please check platform specific notes in this doc, if you haven't
761 > packaging before for other platform
762 specific issues. Conversely, please add any notes that you know
763 are important for your platform (or contact one of the doc
764 maintainers to do this if you can't).
769 > Packagers should do a <SPAN
773 package after building it. So any previous installs should be
774 removed first to ensure the integrity of the newly built package.
775 Then run the package for a while to make sure there are no
776 obvious problems, before uploading.
786 NAME="NEWRELEASE-TARBALL"
787 >6.3.2. Source Tarball</A
794 >make sure that you have freshly exported the right
795 version into an empty directory</I
797 >. (See "Building and releasing
798 packages" above). Then run:
807 CLASS="PROGRAMLISTING"
809 autoheader && autoconf && ./configure</PRE
823 CLASS="PROGRAMLISTING"
824 > make tarball-dist</PRE
829 > To upload the package to Sourceforge, simply issue
838 CLASS="PROGRAMLISTING"
839 > make tarball-upload</PRE
844 > Go to the displayed URL and release the file publicly on Sourceforge.
845 For the change log field, use the relevant section of the
857 NAME="NEWRELEASE-RPM"
858 >6.3.3. SuSE, Conectiva or Red Hat RPM</A
861 > In following text, replace <TT
870 > for Red Hat or <SPAN
880 >make sure that you have freshly exported the right
881 version into an empty directory</I
883 >. (See "Building and releasing
887 > As the only exception to not changing anything after export from Git,
888 now examine the file <TT
900 and make sure that the version information and the RPM release number are
901 correct. The RPM release numbers for each version start at one. Hence it must
902 be reset to one if this is the first RPM for
908 > which is built from version
911 HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
915 > if unsure. Else, it must be set to the highest already available RPM
916 release number for that version plus one.
928 CLASS="PROGRAMLISTING"
930 autoheader && autoconf && ./configure</PRE
944 CLASS="PROGRAMLISTING"
955 > To upload the package to Sourceforge, simply issue
964 CLASS="PROGRAMLISTING"
986 RPM release number as determined above.
987 Go to the displayed URL and release the file publicly on Sourceforge.
988 Use the release notes and change log from the source tarball package.
996 NAME="NEWRELEASE-OS2"
1004 >make sure that you have freshly exported the right
1005 version into an empty directory</I
1007 >. (See "Building and releasing
1008 packages" above). Then get the OS/2 Setup module:
1017 CLASS="PROGRAMLISTING"
1018 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
1023 > You will need a mix of development tools.
1024 The main compilation takes place with IBM Visual Age C++.
1025 Some ancillary work takes place with GNU tools, available from
1026 various sources like hobbes.nmsu.edu.
1027 Specificially, you will need <TT
1038 The packaging takes place with WarpIN, available from various sources, including
1040 HREF="http://www.xworkplace.org/"
1046 > Change directory to the <TT
1050 Edit the os2build.cmd file to set the final executable filename.
1060 CLASS="PROGRAMLISTING"
1061 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
1066 > Next, edit the <TT
1069 > file so the release number matches
1082 CLASS="PROGRAMLISTING"
1083 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
1088 > You're now ready to build. Run:
1097 CLASS="PROGRAMLISTING"
1103 > You will find the WarpIN-installable executable in the
1107 > directory. Upload this anonymously to
1110 >uploads.sourceforge.net/incoming</TT
1112 for it, and you're done. Use the release notes and Change Log from the
1113 source tarball package.
1121 NAME="NEWRELEASE-SOLARIS"
1125 > Login to Sourceforge's compilefarm via ssh:
1134 CLASS="PROGRAMLISTING"
1135 > ssh cf.sourceforge.net</PRE
1140 > Choose the right operating system (not the Debian one).
1141 When logged in, <SPAN
1145 >make sure that you have freshly exported the right
1146 version into an empty directory</I
1148 >. (See "Building and releasing
1149 packages" above). Then run:
1158 CLASS="PROGRAMLISTING"
1160 autoheader && autoconf && ./configure</PRE
1174 CLASS="PROGRAMLISTING"
1175 > gmake solaris-dist</PRE
1180 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1184 > on the Sourceforge machine (no ncftpput). You now have
1185 to manually upload the archive to Sourceforge's ftp server and release
1186 the file publicly. Use the release notes and Change Log from the
1187 source tarball package.
1195 NAME="NEWRELEASE-WINDOWS"
1200 HREF="http://www.fruitbat.org/Cygwin/index.html#cygwincirca"
1202 > Cygwin Time Machine</A
1203 > to install the last 1.5 version of Cygwin.
1204 Run the following commands from within the Cygwin 1.5 bash shell.
1211 >make sure that you have freshly exported the right
1212 version into an empty directory</I
1214 >. (See "Building and releasing
1215 packages" above). Then get the Windows setup module:
1224 CLASS="PROGRAMLISTING"
1225 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1230 > Then you can build the package. This is fully automated, and is
1233 >winsetup/GNUmakefile</TT
1235 All you need to do is:
1244 CLASS="PROGRAMLISTING"
1251 > Now you can manually rename <TT
1253 >privoxy_setup.exe</TT
1257 >privoxy_setup_X_Y_Z.exe</TT
1259 SourceForge. When releasing the package on SourceForge, use the release notes
1260 and Change Log from the source tarball package.
1268 NAME="NEWRELEASE-DEBIAN"
1276 >make sure that you have freshly exported the
1277 right version into an empty directory</I
1280 "Building and releasing packages" above). Then add a log
1283 >debian/changelog</TT
1285 already there, for example by running:
1294 CLASS="PROGRAMLISTING"
1295 > debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</PRE
1309 CLASS="PROGRAMLISTING"
1310 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1318 >../privoxy_3.0.27-UNRELEASED-1_i386.deb</TT
1320 which can be uploaded. To upload the package to Sourceforge, simply
1330 CLASS="PROGRAMLISTING"
1331 > make debian-upload</PRE
1341 NAME="NEWRELEASE-MACOSX"
1349 >make sure that you have freshly exported the right
1350 version into an empty directory</I
1352 >. (See "Building and releasing
1356 > There are three modules available in the Git repository for use on Mac
1357 OS X, though technically only two of them generate a release (the other
1358 can be used to install from source).
1365 NAME="OS-X-OSXPACKAGEBUILDER-MODULE"
1366 >6.3.8.1. OSXPackageBuilder module</A
1369 > The OSXPackageBuilder module generates OS X installer packages
1370 supporting all Macs running OS X 10.4 and above. Obtain it from Git as
1371 follows into a folder parallel to the exported privoxy source:
1380 CLASS="PROGRAMLISTING"
1381 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder</PRE
1386 > The module contains complete instructions on its usage in the file
1389 >OS X Package Builder HOWTO.txt</TT
1393 > Once the package(s) have been generated, you can then upload them
1394 directly to the Files section of the Sourceforge project in the
1395 Macintosh (OS X) folder. Each new version release of Privoxy should
1396 have a new subfolder created in which to store its files. Please
1397 ensure that the folder contains a readme file that makes it clear
1398 which package is for whichversion of OS X.
1406 NAME="OS-X-OSXSETUP-MODULE"
1407 >6.3.8.2. osxsetup module (DEPRECATED)</A
1414 >This module is deprecated since the installer it generates
1415 places all Privoxy files in one folder in a non-standard location, and
1416 supports only Intel Macs running OS X 10.6 or higher.</I
1421 > Check out the module from Git as follows into a folder parallel to the
1422 exported privoxy source:
1431 CLASS="PROGRAMLISTING"
1432 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1446 CLASS="PROGRAMLISTING"
1467 Finally, it will copy over the necessary files to the ./osxsetup/files
1468 directory for further processing by <TT
1474 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file,
1475 modify the package name to match the release, and hit the "Create
1476 package" button. If you specify ./Privoxy.pkg as the output package
1477 name, you can then create the distributable zip file with the command:
1486 CLASS="PROGRAMLISTING"
1487 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1492 > You can then upload this file directly to the Files section of the
1493 Sourceforge project in the Macintosh (OS X) folder. Each new version
1494 release of Privoxy should have a new subfolder created in which to
1496 Please ensure that the folder contains a readme file that makes it
1497 clear which version(s) of OS X the package supports.
1505 NAME="OS-X-MACSETUP-MODULE"
1506 >6.3.8.3. macsetup module</A
1509 > The macsetup module is ideal if you wish to build and install Privoxy
1510 from source on a single machine.
1513 > Check out the module from Git as follows into a folder parallel to the
1514 exported privoxy source:
1523 CLASS="PROGRAMLISTING"
1524 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup</PRE
1529 > The module contains complete instructions on its usage in its
1533 > file. The end result will be the
1534 exported version of Privoxy installed on the build machine.
1543 NAME="NEWRELEASE-FREEBSD"
1547 > Update the www/privoxy port and submit a diff upstream.
1548 For details see the <A
1549 HREF="https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/"
1551 >FreeBSD Porter's Handbook</A
1562 >6.4. Uploading and Releasing Your Package</A
1565 > After the package is ready, it is time to upload it
1566 to SourceForge, and go through the release steps. The upload
1575 HREF="ftp://upload.sourceforge.net/incoming"
1577 >ftp://upload.sourceforge.net/incoming</A
1593 >ijbswa-developers@lists.sourceforge.net</TT
1602 > targets as described above.
1605 > Once this done go to <A
1606 HREF="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1608 >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1610 making sure you are logged in. Find your target platform in the
1611 second column, and click <TT
1615 then need to create a new release for your package, using the format
1618 >$VERSION ($CODE_STATUS)</TT
1629 > Now just follow the prompts. Be sure to add any appropriate Release
1630 notes. You should see your freshly uploaded packages in
1633 >"Step 2. Add Files To This Release"</SPAN
1635 appropriate box(es). Remember at each step to hit the
1638 >"Refresh/Submit"</SPAN
1639 > buttons! You should now see your
1640 file(s) listed in Step 3. Fill out the forms with the appropriate
1641 information for your platform, being sure to hit <SPAN
1645 for each file. If anyone is monitoring your platform, check the
1649 > box at the very bottom to notify them of
1650 the new package. This should do it!
1653 > If you have made errors, or need to make changes, you can go through
1654 essentially the same steps, but select <TT
1670 >6.5. After the Release</A
1673 > When all (or: most of the) packages have been uploaded and made available,
1674 send an email to the <A
1675 HREF="mailto:privoxy-announce@lists.privoxy.org"
1679 >, Subject: "Version X.Y.Z available for download". Be sure to
1682 HREF="https://sourceforge.net/project/showfiles.php?group_id=11118"
1686 >, the release notes and the Changelog. Also, post an
1687 updated News item on the project page Sourceforge, and update the Home
1688 page and docs linked from the Home page (see below). Other news sites
1689 and release oriented sites, such as Freshmeat, should also be notified.
1698 SUMMARY="Footer navigation table"
1727 HREF="webserver-update.html"
1737 >Testing Guidelines</TD
1747 >Update the Webserver</TD