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@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
468 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.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.
487 > Please find additional instructions for the source tarball and the
488 individual platform dependent binary packages below. And details
489 on the Sourceforge release process below that.
496 NAME="PACK-GUIDELINES"
498 >6.3.1. Note on Privoxy Packaging</H3
500 > Please keep these general guidelines in mind when putting together
501 your package. These apply to <SPAN
525 write access to: all <TT
529 logfiles, and the <TT
533 need to determine the best way to do this for your platform.
538 > Please include up to date documentation. At a bare minimum:
550 > (top-level directory)
567 > (top-level directory)
584 > (top-level directory)
601 > (top-level directory, Unix-like
619 > (doc/webserver/user-manual/)
636 > (doc/webserver/faq/)
644 > Also suggested: <TT
646 >Developer Manual</TT
648 (doc/webserver/developer-manual) and <TT
652 (top-level directory). <TT
655 > and the manuals are
656 HTML docs. There are also text versions in
660 > which could conceivably also be
664 > The documentation has been designed such that the manuals are linked
665 to each other from parallel directories, and should be packaged
668 >privoxy-index.html</TT
670 included and can serve as a focal point for docs and other links of
671 interest (and possibly renamed to <TT
675 This should be one level up from the manuals. There is a link also
676 on this page to an HTMLized version of the man page. To avoid 404 for
677 this, it is in CVS as
680 >doc/webserver/man-page/privoxy-man-page.html</TT
682 and should be included along with the manuals. There is also a
683 css stylesheets that can be included for better presentation:
687 >. This should be in the same directory
690 >privoxy-index.html</TT
691 >, (i.e. one level up from
692 the manual directories).
700 > is designed for local preferences.
701 Make sure this does not get overwritten!
706 > Other configuration files should be installed as the new defaults,
707 but all previously installed configuration files should be preserved
708 as backups. This is just good manners :-)
713 > Please check platform specific notes in this doc, if you haven't
717 > packaging before for other platform
718 specific issues. Conversely, please add any notes that you know
719 are important for your platform (or contact one of the doc
720 maintainers to do this if you can't).
725 > Packagers should do a <SPAN
729 package after building it. So any previous installs should be
730 removed first to ensure the integrity of the newly built package.
731 Then run the package for a while to make sure there are no
732 obvious problems, before uploading.
744 NAME="NEWRELEASE-TARBALL"
746 >6.3.2. Source Tarball</H3
752 >make sure that you have freshly exported the right
753 version into an empty directory</I
755 >. (See "Building and releasing
756 packages" above). Then run:
766 CLASS="PROGRAMLISTING"
768 autoheader && autoconf && ./configure</PRE
785 CLASS="PROGRAMLISTING"
786 > make tarball-dist</PRE
793 > To upload the package to Sourceforge, simply issue
803 CLASS="PROGRAMLISTING"
804 > make tarball-upload</PRE
811 > Go to the displayed URL and release the file publicly on Sourceforge.
812 For the change log field, use the relevant section of the
824 NAME="NEWRELEASE-RPM"
826 >6.3.3. SuSE, Conectiva or Red Hat RPM</H3
828 > In following text, replace <TT
837 > for Red Hat or <SPAN
847 >make sure that you have freshly exported the right
848 version into an empty directory</I
850 >. (See "Building and releasing
854 > As the only exception to not changing anything after export from CVS,
855 now examine the file <TT
867 and make sure that the version information and the RPM release number are
868 correct. The RPM release numbers for each version start at one. Hence it must
869 be reset to one if this is the first RPM for
875 > which is built from version
878 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
882 > if unsure. Else, it must be set to the highest already available RPM
883 release number for that version plus one.
896 CLASS="PROGRAMLISTING"
898 autoheader && autoconf && ./configure</PRE
915 CLASS="PROGRAMLISTING"
928 > To upload the package to Sourceforge, simply issue
938 CLASS="PROGRAMLISTING"
962 RPM release number as determined above.
963 Go to the displayed URL and release the file publicly on Sourceforge.
964 Use the release notes and change log from the source tarball package.
972 NAME="NEWRELEASE-OS2"
980 >make sure that you have freshly exported the right
981 version into an empty directory</I
983 >. (See "Building and releasing
984 packages" above). Then get the OS/2 Setup module:
994 CLASS="PROGRAMLISTING"
995 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</PRE
1002 > You will need a mix of development tools.
1003 The main compilation takes place with IBM Visual Age C++.
1004 Some ancillary work takes place with GNU tools, available from
1005 various sources like hobbes.nmsu.edu.
1006 Specificially, you will need <TT
1017 The packaging takes place with WarpIN, available from various sources, including
1019 HREF="http://www.xworkplace.org/"
1025 > Change directory to the <TT
1029 Edit the os2build.cmd file to set the final executable filename.
1040 CLASS="PROGRAMLISTING"
1041 > installExeName='privoxyos2_setup_X.Y.Z.exe'</PRE
1048 > Next, edit the <TT
1051 > file so the release number matches
1065 CLASS="PROGRAMLISTING"
1066 > PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</PRE
1073 > You're now ready to build. Run:
1083 CLASS="PROGRAMLISTING"
1091 > You will find the WarpIN-installable executable in the
1095 > directory. Upload this anonymously to
1098 >uploads.sourceforge.net/incoming</TT
1100 for it, and you're done. Use the release notes and Change Log from the
1101 source tarball package.
1109 NAME="NEWRELEASE-SOLARIS"
1113 > Login to Sourceforge's compilefarm via ssh:
1123 CLASS="PROGRAMLISTING"
1124 > ssh cf.sourceforge.net</PRE
1131 > Choose the right operating system (not the Debian one).
1132 When logged in, <SPAN
1136 >make sure that you have freshly exported the right
1137 version into an empty directory</I
1139 >. (See "Building and releasing
1140 packages" above). Then run:
1150 CLASS="PROGRAMLISTING"
1152 autoheader && autoconf && ./configure</PRE
1169 CLASS="PROGRAMLISTING"
1170 > gmake solaris-dist</PRE
1177 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1181 > on the Sourceforge machine (no ncftpput). You now have
1182 to manually upload the archive to Sourceforge's ftp server and release
1183 the file publicly. Use the release notes and Change Log from the
1184 source tarball package.
1192 NAME="NEWRELEASE-WINDOWS"
1196 > You should ensure you have the latest version of Cygwin (from
1198 HREF="http://www.cygwin.com/"
1200 >http://www.cygwin.com/</A
1202 Run the following commands from within a Cygwin bash shell.
1209 >make sure that you have freshly exported the right
1210 version into an empty directory</I
1212 >. (See "Building and releasing
1213 packages" above). Then get the Windows setup module:
1223 CLASS="PROGRAMLISTING"
1224 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</PRE
1231 > Then you can build the package. This is fully automated, and is
1234 >winsetup/GNUmakefile</TT
1236 All you need to do is:
1246 CLASS="PROGRAMLISTING"
1255 > Now you can manually rename <TT
1257 >privoxy_setup.exe</TT
1261 >privoxy_setup_X_Y_Z.exe</TT
1263 SourceForge. When releasing the package on SourceForge, use the release notes
1264 and Change Log from the source tarball package.
1272 NAME="NEWRELEASE-DEBIAN"
1280 >make sure that you have freshly exported the
1281 right version into an empty directory</I
1284 "Building and releasing packages" above). Then add a log
1287 >debian/changelog</TT
1289 already there, for example by running:
1299 CLASS="PROGRAMLISTING"
1300 > debchange -v 3.0.4-BETA-1 "New upstream version"</PRE
1317 CLASS="PROGRAMLISTING"
1318 > dpkg-buildpackage -rfakeroot -us -uc -b</PRE
1328 >../privoxy_3.0.4-BETA-1_i386.deb</TT
1330 which can be uploaded. To upload the package to Sourceforge, simply
1341 CLASS="PROGRAMLISTING"
1342 > make debian-upload</PRE
1354 NAME="NEWRELEASE-MACOSX"
1362 >make sure that you have freshly exported the right
1363 version into an empty directory</I
1365 >. (See "Building and releasing
1366 packages" above). Then get the Mac OSX setup module:
1376 CLASS="PROGRAMLISTING"
1377 > cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</PRE
1394 CLASS="PROGRAMLISTING"
1417 Finally, it will copy over the necessary files to the ./osxsetup/files directory
1418 for further processing by <TT
1424 > Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
1425 name to match the release, and hit the "Create package" button.
1426 If you specify ./Privoxy.pkg as the output package name, you can then create
1427 the distributable zip file with the command:
1437 CLASS="PROGRAMLISTING"
1438 > zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</PRE
1445 > You can then upload <TT
1447 >privoxyosx_setup_x.y.z.zip</TT
1451 >uploads.sourceforge.net/incoming</TT
1453 create a release for it, and you're done. Use the release notes
1454 and Change Log from the source tarball package.
1462 NAME="NEWRELEASE-FREEBSD"
1466 > Login to Sourceforge's compile-farm via ssh:
1476 CLASS="PROGRAMLISTING"
1477 > ssh cf.sourceforge.net</PRE
1484 > Choose the right operating system.
1485 When logged in, <SPAN
1489 >make sure that you have freshly exported the right
1490 version into an empty directory</I
1492 >. (See "Building and releasing
1493 packages" above). Then run:
1503 CLASS="PROGRAMLISTING"
1505 autoheader && autoconf && ./configure</PRE
1522 CLASS="PROGRAMLISTING"
1523 > gmake freebsd-dist</PRE
1530 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1534 > on the Sourceforge machine (no ncftpput). You now have
1535 to manually upload the archive to Sourceforge's ftp server and release
1536 the file publicly. Use the release notes and Change Log from the
1537 source tarball package.
1545 NAME="NEWRELEASE-HPUX"
1547 >6.3.10. HP-UX 11</H3
1553 >make sure that you have freshly exported the right
1554 version into an empty directory</I
1556 >. (See "Building and releasing
1557 packages" above). Then run:
1567 CLASS="PROGRAMLISTING"
1569 autoheader && autoconf && ./configure</PRE
1584 NAME="NEWRELEASE-AMIGA"
1586 >6.3.11. Amiga OS</H3
1592 >make sure that you have freshly exported the right
1593 version into an empty directory</I
1595 >. (See "Building and releasing
1596 packages" above). Then run:
1606 CLASS="PROGRAMLISTING"
1608 autoheader && autoconf && ./configure</PRE
1623 NAME="NEWRELEASE-AIX"
1627 > Login to Sourceforge's compilefarm via ssh:
1637 CLASS="PROGRAMLISTING"
1638 > ssh cf.sourceforge.net</PRE
1645 > Choose the right operating system.
1646 When logged in, <SPAN
1650 >make sure that you have freshly exported the right
1651 version into an empty directory</I
1653 >. (See "Building and releasing
1654 packages" above). Then run:
1664 CLASS="PROGRAMLISTING"
1666 autoheader && autoconf && ./configure</PRE
1683 CLASS="PROGRAMLISTING"
1684 > make aix-dist</PRE
1691 > which creates a gzip'ed tar archive. Sadly, you cannot use <B
1695 > on the Sourceforge machine (no ncftpput). You now have
1696 to manually upload the archive to Sourceforge's ftp server and release
1697 the file publicly. Use the release notes and Change Log from the
1698 source tarball package.
1709 >6.4. Uploading and Releasing Your Package</H2
1711 > After the package is ready, it is time to upload it
1712 to SourceForge, and go through the release steps. The upload
1722 HREF="ftp://upload.sourceforge.net/incoming"
1724 >ftp://upload.sourceforge.net/incoming</A
1740 >ijbswa-developers@lists.sourceforge.net</TT
1751 > targets as described above.
1754 > Once this done go to <A
1755 HREF="http://sourceforge.net/project/admin/editpackages.php?group_id=11118"
1757 >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A
1759 making sure you are logged in. Find your target platform in the
1760 second column, and click <TT
1764 then need to create a new release for your package, using the format
1767 >$VERSION ($CODE_STATUS)</TT
1778 > Now just follow the prompts. Be sure to add any appropriate Release
1779 notes. You should see your freshly uploaded packages in
1782 >"Step 2. Add Files To This Release"</SPAN
1784 appropriate box(es). Remember at each step to hit the
1787 >"Refresh/Submit"</SPAN
1788 > buttons! You should now see your
1789 file(s) listed in Step 3. Fill out the forms with the appropriate
1790 information for your platform, being sure to hit <SPAN
1794 for each file. If anyone is monitoring your platform, check the
1798 > box at the very bottom to notify them of
1799 the new package. This should do it!
1802 > If you have made errors, or need to make changes, you can go through
1803 essentially the same steps, but select <TT
1820 >6.5. After the Release</H2
1822 > When all (or: most of the) packages have been uploaded and made available,
1823 send an email to the <A
1824 HREF="mailto:ijbswa-announce@lists.sourceforge.net"
1828 >, Subject: "Version X.Y.Z available for download". Be sure to
1831 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
1835 >, the release notes and the Changelog. Also, post an
1836 updated News item on the project page Sourceforge, and update the Home
1837 page and docs linked from the Home page (see below).
1846 SUMMARY="Footer navigation table"
1875 HREF="webserver-update.html"
1885 >Testing Guidelines</TD
1895 >Update the Webserver</TD