doc/webserver/developer-manual/newrelease.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>Releasing a New Version</title>
   6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   7   <link rel="HOME" title="Privoxy Developer Manual" href="index.html">
   8   <link rel="PREVIOUS" title="Testing Guidelines" href="testing.html">
   9   <link rel="NEXT" title="Update the Webserver" href="webserver-update.html">
  10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  11   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12 </head>
  13 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
  14   <div class="NAVHEADER">
  15     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
  16       <tr>
  17         <th colspan="3" align="center">Privoxy Developer Manual</th>
  18       </tr>
  19       <tr>
  20         <td width="10%" align="left" valign="bottom"><a href="testing.html" accesskey="P">Prev</a></td>
  21         <td width="80%" align="center" valign="bottom"></td>
  22         <td width="10%" align="right" valign="bottom"><a href="webserver-update.html" accesskey="N">Next</a></td>
  23       </tr>
  24     </table>
  25     <hr align="left" width="100%">
  26   </div>
  27   <div class="SECT1">
  28     <h1 class="SECT1"><a name="NEWRELEASE" id="NEWRELEASE">6. Releasing a New Version</a></h1>
  29     <p>When we release versions of <span class="APPLICATION">Privoxy</span>, our work leaves our cozy secret lab and
  30     has to work in the cold RealWorld[tm]. Once it is released, there is no way to call it back, so it is very
  31     important that great care is taken to ensure that everything runs fine, and not to introduce problems in the very
  32     last minute.</p>
  33     <p>So when releasing a new version, please adhere exactly to the procedure outlined in this chapter.</p>
  34     <p>The following programs are required to follow this process: <tt class="FILENAME">ncftpput</tt> (ncftp),
  35     <tt class="FILENAME">scp, ssh</tt> (ssh), <tt class="FILENAME">gmake</tt> (GNU's version of make), autoconf,
  36     cvs.</p>
  37     <div class="SECT2">
  38       <h2 class="SECT2"><a name="VERSIONNUMBERS" id="VERSIONNUMBERS">6.1. Version numbers</a></h2>
  39       <p>First you need to determine which version number the release will have. <span class=
  40       "APPLICATION">Privoxy</span> version numbers consist of three numbers, separated by dots, like in X.Y.Z (e.g.
  41       3.0.0), where:</p>
  42       <ul>
  43         <li>
  44           <p>X, the version major, is rarely ever changed. It is increased by one if turning a development branch into
  45           stable substantially changes the functionality, user interface or configuration syntax. Majors 1 and 2 were
  46           <span class="APPLICATION">Junkbuster</span>, and 3 will be the first stable <span class=
  47           "APPLICATION">Privoxy</span> release.</p>
  48         </li>
  49         <li>
  50           <p>Y, the version minor, represents the branch within the major version. At any point in time, there are two
  51           branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is being
  52           added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of
  53           <span class="APPLICATION">Privoxy</span> takes place. This enables us to turn the code upside down and inside
  54           out, while at the same time providing and maintaining a stable version. The minor is reset to zero (and one)
  55           when the major is incremented. When a development branch has matured to the point where it can be turned into
  56           stable, the old stable branch 2N is given up (i.e. no longer maintained), the former development branch 2N+1
  57           becomes the new stable branch 2N+2, and a new development branch 2N+3 is opened.</p>
  58         </li>
  59         <li>
  60           <p>Z, the point or sub version, represents a release of the software within a branch. It is therefore
  61           incremented immediately before each code freeze. In development branches, only the even point versions
  62           correspond to actual releases, while the odd ones denote the evolving state of the sources on CVS in between.
  63           It follows that Z is odd on CVS in development branches most of the time. There, it gets increased to an even
  64           number immediately before a code freeze, and is increased to an odd number again immediately thereafter. This
  65           ensures that builds from CVS snapshots are easily distinguished from released versions. The point version is
  66           reset to zero when the minor changes.</p>
  67           <p>Stable branches work a little differently, since there should be little to no development happening in
  68           such branches. Remember, only bugfixes, which presumably should have had some testing before being committed.
  69           Stable branches will then have their version reported as <tt class="LITERAL">0.0.0</tt>, during that period
  70           between releases when changes are being added. This is to denote that this code is <span class=
  71           "emphasis"><i class="EMPHASIS">not for release</i></span>. Then as the release nears, the version is bumped
  72           according: e.g. <tt class="LITERAL">3.0.1 -&gt; 0.0.0 -&gt; 3.0.2</tt>.</p>
  73         </li>
  74       </ul>
  75       <p>In summary, the main CVS trunk is the development branch where new features are being worked on for the next
  76       stable series. This should almost always be where the most activity takes place. There is always at least one
  77       stable branch from the trunk, e.g now it is <tt class="LITERAL">3.0</tt>, which is only used to release stable
  78       versions. Once the initial *.0 release of the stable branch has been done, then as a rule, only bugfixes that
  79       have had prior testing should be committed to the stable branch. Once there are enough bugfixes to justify a new
  80       release, the version of this branch is again incremented Example: 3.0.0 -&gt; 3.0.1 -&gt; 3.0.2, etc are all
  81       stable releases from within the stable branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
  82       taking place. If any questions, please post to the devel list <span class="emphasis"><i class=
  83       "EMPHASIS">before</i></span> committing to a stable branch!</p>
  84       <p>Developers should remember too that if they commit a bugfix to the stable branch, this will more than likely
  85       require a separate submission to the main trunk, since these are separate development trees within CVS. If you
  86       are working on both, then this would require at least two separate check outs (i.e main trunk, <span class=
  87       "emphasis"><i class="EMPHASIS">and</i></span> the stable release branch, which is <tt class=
  88       "LITERAL">v_3_0_branch</tt> at the moment).</p>
  89     </div>
  90     <div class="SECT2">
  91       <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release: Freeze</a></h2>
  92       <p>The following <span class="emphasis"><i class="EMPHASIS">must be done by one of the developers</i></span>
  93       prior to each new release.</p>
  94       <ul>
  95         <li>
  96           <p>Make sure that everybody who has worked on the code in the last couple of days has had a chance to yell
  97           <span class="QUOTE">"no!"</span> in case they have pending changes/fixes in their pipelines. Announce the
  98           freeze so that nobody will interfere with last minute changes.</p>
  99         </li>
 100         <li>
 101           <p>Increment the version number (point from odd to even in development branches!) in <tt class=
 102           "FILENAME">configure.in</tt> and update the code status (CODE_STATUS="xxx") to one of "alpha", "beta" or
 103           "stable". Rebuild configure and GNUMakefile to make sure the updated values are being used.</p>
 104         </li>
 105         <li>
 106           <p>Use the dok-release target to update the sgml documentation source files.</p>
 107         </li>
 108         <li>
 109           <p>If action file processing has changed and is not backward-compatible, make sure the
 110           "for-privoxy-version=x.y.z" minimum version number in default.action.master has been updated:</p>
 111           <table border="0" bgcolor="#E0E0E0" width="90%">
 112             <tr>
 113               <td>
 114                 <pre class="PROGRAMLISTING">{{settings}}
 115 #############################################################################
 116 #MASTER# COMMENT: The minimum Privoxy version:
 117 for-privoxy-version=3.0.11</pre>
 118               </td>
 119             </tr>
 120           </table>
 121         </li>
 122         <li>
 123           <p>All documentation should be rebuild after the version bump. Finished docs should be then be committed to
 124           CVS (for those without the ability to build these). Some docs may require rather obscure processing tools.
 125           <tt class="FILENAME">config</tt>, the man page (and the html version of the man page) fall in this category.
 126           README, the man page, AUTHORS, and config should all also be committed to CVS for other packagers. The formal
 127           docs should be uploaded to the webserver. See the Section "Updating the webserver" in this manual for
 128           details.</p>
 129         </li>
 130         <li>
 131           <p>The <i class="CITETITLE">User Manual</i> is also used for context sensitive help for the CGI editor. This
 132           is version sensitive, so that the user will get appropriate help for his/her release. So with each release a
 133           fresh version should be uploaded to the webserver (this is in addition to the main <i class="CITETITLE">User
 134           Manual</i> link from the main page since we need to keep manuals for various versions available). The CGI
 135           pages will link to something like <tt class="LITERAL">http://privoxy.org/$(VERSION)/user-manual/</tt>. This
 136           will need to be updated for each new release. There is no Makefile target for this at this time!!! It needs
 137           to be done manually.</p>
 138         </li>
 139         <li>
 140           <p>All developers should look at the <tt class="FILENAME">ChangeLog</tt> and make sure noteworthy changes are
 141           referenced.</p>
 142         </li>
 143         <li>
 144           <p><span class="emphasis"><i class="EMPHASIS">Commit all files that were changed in the above
 145           steps!</i></span></p>
 146         </li>
 147         <li>
 148           <p>Tag all files in CVS with the version number with <span class="QUOTE">"<b class="COMMAND">cvs tag
 149           v_X_Y_Z</b>"</span>. Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.</p>
 150         </li>
 151         <li>
 152           <p>If the release was in a development branch, increase the point version from even to odd (X.Y.(Z+1)) again
 153           in <tt class="FILENAME">configure.in</tt> and commit your change.</p>
 154         </li>
 155         <li>
 156           <p>On the webserver, copy the user manual to a new top-level directory called <tt class=
 157           "FILENAME">X.Y.Z</tt>. This ensures that help links from the CGI pages, which have the version as a prefix,
 158           will go into the right version of the manual. If this is a development branch release, also symlink
 159           <tt class="FILENAME">X.Y.(Z-1)</tt> to <tt class="FILENAME">X.Y.Z</tt> and <tt class=
 160           "FILENAME">X.Y.(Z+1)</tt> to <tt class="FILENAME">.</tt> (i.e. dot).</p>
 161         </li>
 162       </ul>
 163     </div>
 164     <div class="SECT2">
 165       <h2 class="SECT2"><a name="THERELEASE" id="THERELEASE">6.3. Building and Releasing the Packages</a></h2>
 166       <p>Now the individual packages can be built and released. Note that for GPL reasons the first package to be
 167       released is always the source tarball.</p>
 168       <p>For <span class="emphasis"><i class="EMPHASIS">all</i></span> types of packages, including the source tarball,
 169       <span class="emphasis"><i class="EMPHASIS">you must make sure that you build from clean sources by exporting the
 170       right version from CVS into an empty directory</i></span> (just press return when asked for a password):</p>
 171       <table border="0" bgcolor="#E0E0E0" width="100%">
 172         <tr>
 173           <td>
 174             <pre class="PROGRAMLISTING">  mkdir dist # delete or choose different name if it already exists
 175   cd dist
 176   cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
 177   cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current</pre>
 178           </td>
 179         </tr>
 180       </table>
 181       <p><span class="emphasis"><i class="EMPHASIS">Do NOT change</i></span> a single bit, including, but not limited
 182       to version information after export from CVS. This is to make sure that all release packages, and with them, all
 183       future bug reports, are based on exactly the same code.</p>
 184       <div class="WARNING">
 185         <table class="WARNING" border="1" width="100%">
 186           <tr>
 187             <td align="center"><b>Warning</b></td>
 188           </tr>
 189           <tr>
 190             <td align="left">
 191               <p>Every significant release of Privoxy has included at least one package that either had incorrect
 192               versions of files, missing files, or incidental leftovers from a previous build process that gave unknown
 193               numbers of users headaches to try to figure out what was wrong. PLEASE, make sure you are using pristene
 194               sources, and are following the prescribed process!</p>
 195             </td>
 196           </tr>
 197         </table>
 198       </div>
 199       <p>Please find additional instructions for the source tarball and the individual platform dependent binary
 200       packages below. And details on the Sourceforge release process below that.</p>
 201       <div class="SECT3">
 202         <h3 class="SECT3"><a name="PACK-GUIDELINES" id="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</a></h3>
 203         <p>Please keep these general guidelines in mind when putting together your package. These apply to <span class=
 204         "emphasis"><i class="EMPHASIS">all</i></span> platforms!</p>
 205         <ul>
 206           <li>
 207             <p><span class="APPLICATION">Privoxy</span> <span class="emphasis"><i class="EMPHASIS">requires</i></span>
 208             write access to: all <tt class="FILENAME">*.action</tt> files, all logfiles, and the <tt class=
 209             "FILENAME">trust</tt> file. You will need to determine the best way to do this for your platform.</p>
 210           </li>
 211           <li>
 212             <p>Please include up to date documentation. At a bare minimum:</p>
 213             <table border="0">
 214               <tbody>
 215                 <tr>
 216                   <td><tt class="FILENAME">LICENSE</tt> (top-level directory)</td>
 217                 </tr>
 218               </tbody>
 219             </table>
 220             <table border="0">
 221               <tbody>
 222                 <tr>
 223                   <td><tt class="FILENAME">README</tt> (top-level directory)</td>
 224                 </tr>
 225               </tbody>
 226             </table>
 227             <table border="0">
 228               <tbody>
 229                 <tr>
 230                   <td><tt class="FILENAME">AUTHORS</tt> (top-level directory)</td>
 231                 </tr>
 232               </tbody>
 233             </table>
 234             <table border="0">
 235               <tbody>
 236                 <tr>
 237                   <td><tt class="FILENAME">man page</tt> (top-level directory, Unix-like platforms only)</td>
 238                 </tr>
 239               </tbody>
 240             </table>
 241             <table border="0">
 242               <tbody>
 243                 <tr>
 244                   <td><tt class="FILENAME">The User Manual</tt> (doc/webserver/user-manual/)</td>
 245                 </tr>
 246               </tbody>
 247             </table>
 248             <table border="0">
 249               <tbody>
 250                 <tr>
 251                   <td><tt class="FILENAME">FAQ</tt> (doc/webserver/faq/)</td>
 252                 </tr>
 253               </tbody>
 254             </table>
 255             <p>Also suggested: <tt class="FILENAME">Developer Manual</tt> (doc/webserver/developer-manual) and
 256             <tt class="FILENAME">ChangeLog</tt> (top-level directory). <tt class="FILENAME">FAQ</tt> and the manuals
 257             are HTML docs. There are also text versions in <tt class="FILENAME">doc/text/</tt> which could conceivably
 258             also be included.</p>
 259             <p>The documentation has been designed such that the manuals are linked to each other from parallel
 260             directories, and should be packaged that way. <tt class="FILENAME">privoxy-index.html</tt> can also be
 261             included and can serve as a focal point for docs and other links of interest (and possibly renamed to
 262             <tt class="FILENAME">index.html</tt>). This should be one level up from the manuals. There is a link also
 263             on this page to an HTMLized version of the man page. To avoid 404 for this, it is in CVS as <tt class=
 264             "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt>, and should be included along with the
 265             manuals. There is also a css stylesheets that can be included for better presentation: <tt class=
 266             "FILENAME">p_doc.css</tt>. This should be in the same directory with <tt class=
 267             "FILENAME">privoxy-index.html</tt>, (i.e. one level up from the manual directories).</p>
 268           </li>
 269           <li>
 270             <p><tt class="FILENAME">user.action</tt> and <tt class="FILENAME">user.filter</tt> are designed for local
 271             preferences. Make sure these do not get overwritten! <tt class="FILENAME">config</tt> should not be
 272             overwritten either. This has especially important configuration data in it. <tt class="FILENAME">trust</tt>
 273             should be left in tact as well.</p>
 274           </li>
 275           <li>
 276             <p>Other configuration files (<tt class="FILENAME">default.action</tt> and <tt class=
 277             "FILENAME">default.filter</tt>) should be installed as the new defaults, but all previously installed
 278             configuration files should be preserved as backups. This is just good manners :-) These files are likely to
 279             change between releases and contain important new features and bug fixes.</p>
 280           </li>
 281           <li>
 282             <p>Please check platform specific notes in this doc, if you haven't done <span class=
 283             "QUOTE">"Privoxy"</span> packaging before for other platform specific issues. Conversely, please add any
 284             notes that you know are important for your platform (or contact one of the doc maintainers to do this if
 285             you can't).</p>
 286           </li>
 287           <li>
 288             <p>Packagers should do a <span class="QUOTE">"clean"</span> install of their package after building it. So
 289             any previous installs should be removed first to ensure the integrity of the newly built package. Then run
 290             the package for a while to make sure there are no obvious problems, before uploading.</p>
 291           </li>
 292         </ul>
 293       </div>
 294       <div class="SECT3">
 295         <h3 class="SECT3"><a name="NEWRELEASE-TARBALL" id="NEWRELEASE-TARBALL">6.3.2. Source Tarball</a></h3>
 296         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 297         into an empty directory</i></span>. (See "Building and releasing packages" above). Then run:</p>
 298         <table border="0" bgcolor="#E0E0E0" width="100%">
 299           <tr>
 300             <td>
 301               <pre class="PROGRAMLISTING">  cd current
 302   autoheader &amp;&amp; autoconf &amp;&amp; ./configure</pre>
 303             </td>
 304           </tr>
 305         </table>
 306         <p>Then do:</p>
 307         <table border="0" bgcolor="#E0E0E0" width="100%">
 308           <tr>
 309             <td>
 310               <pre class="PROGRAMLISTING">  make tarball-dist</pre>
 311             </td>
 312           </tr>
 313         </table>
 314         <p>To upload the package to Sourceforge, simply issue</p>
 315         <table border="0" bgcolor="#E0E0E0" width="100%">
 316           <tr>
 317             <td>
 318               <pre class="PROGRAMLISTING">  make tarball-upload</pre>
 319             </td>
 320           </tr>
 321         </table>
 322         <p>Go to the displayed URL and release the file publicly on Sourceforge. For the change log field, use the
 323         relevant section of the <tt class="FILENAME">ChangeLog</tt> file.</p>
 324       </div>
 325       <div class="SECT3">
 326         <h3 class="SECT3"><a name="NEWRELEASE-RPM" id="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</a></h3>
 327         <p>In following text, replace <tt class="REPLACEABLE"><i>dist</i></tt> with either <span class=
 328         "QUOTE">"rh"</span> for Red Hat or <span class="QUOTE">"suse"</span> for SuSE.</p>
 329         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 330         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 331         <p>As the only exception to not changing anything after export from CVS, now examine the file <tt class=
 332         "FILENAME">privoxy-</tt><tt class="REPLACEABLE"><i>dist</i></tt><tt class="FILENAME">.spec</tt> and make sure
 333         that the version information and the RPM release number are correct. The RPM release numbers for each version
 334         start at one. Hence it must be reset to one if this is the first RPM for <tt class=
 335         "REPLACEABLE"><i>dist</i></tt> which is built from version X.Y.Z. Check the <a href=
 336         "https://sourceforge.net/project/showfiles.php?group_id=11118" target="_top">file list</a> if unsure. Else, it
 337         must be set to the highest already available RPM release number for that version plus one.</p>
 338         <p>Then run:</p>
 339         <table border="0" bgcolor="#E0E0E0" width="100%">
 340           <tr>
 341             <td>
 342               <pre class="PROGRAMLISTING">  cd current
 343   autoheader &amp;&amp; autoconf &amp;&amp; ./configure</pre>
 344             </td>
 345           </tr>
 346         </table>
 347         <p>Then do</p>
 348         <table border="0" bgcolor="#E0E0E0" width="100%">
 349           <tr>
 350             <td>
 351               <pre class="PROGRAMLISTING">  make <tt class="REPLACEABLE"><i>dist</i></tt>-dist</pre>
 352             </td>
 353           </tr>
 354         </table>
 355         <p>To upload the package to Sourceforge, simply issue</p>
 356         <table border="0" bgcolor="#E0E0E0" width="100%">
 357           <tr>
 358             <td>
 359               <pre class="PROGRAMLISTING">  make <tt class="REPLACEABLE"><i>dist</i></tt>-upload <tt class=
 360               "REPLACEABLE"><i>rpm_packagerev</i></tt></pre>
 361             </td>
 362           </tr>
 363         </table>
 364         <p>where <tt class="REPLACEABLE"><i>rpm_packagerev</i></tt> is the RPM release number as determined above. Go
 365         to the displayed URL and release the file publicly on Sourceforge. Use the release notes and change log from
 366         the source tarball package.</p>
 367       </div>
 368       <div class="SECT3">
 369         <h3 class="SECT3"><a name="NEWRELEASE-OS2" id="NEWRELEASE-OS2">6.3.4. OS/2</a></h3>
 370         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 371         into an empty directory</i></span>. (See "Building and releasing packages" above). Then get the OS/2 Setup
 372         module:</p>
 373         <table border="0" bgcolor="#E0E0E0" width="100%">
 374           <tr>
 375             <td>
 376               <pre class="PROGRAMLISTING">
 377               cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup</pre>
 378             </td>
 379           </tr>
 380         </table>
 381         <p>You will need a mix of development tools. The main compilation takes place with IBM Visual Age C++. Some
 382         ancillary work takes place with GNU tools, available from various sources like hobbes.nmsu.edu. Specificially,
 383         you will need <tt class="FILENAME">autoheader</tt>, <tt class="FILENAME">autoconf</tt> and <tt class=
 384         "FILENAME">sh</tt> tools. The packaging takes place with WarpIN, available from various sources, including its
 385         home page: <a href="http://www.xworkplace.org/" target="_top">xworkplace</a>.</p>
 386         <p>Change directory to the <tt class="FILENAME">os2setup</tt> directory. Edit the os2build.cmd file to set the
 387         final executable filename. For example,</p>
 388         <table border="0" bgcolor="#E0E0E0" width="100%">
 389           <tr>
 390             <td>
 391               <pre class="PROGRAMLISTING">  installExeName='privoxyos2_setup_X.Y.Z.exe'</pre>
 392             </td>
 393           </tr>
 394         </table>
 395         <p>Next, edit the <tt class="FILENAME">IJB.wis</tt> file so the release number matches in the <tt class=
 396         "FILENAME">PACKAGEID</tt> section:</p>
 397         <table border="0" bgcolor="#E0E0E0" width="100%">
 398           <tr>
 399             <td>
 400               <pre class="PROGRAMLISTING">  PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"</pre>
 401             </td>
 402           </tr>
 403         </table>
 404         <p>You're now ready to build. Run:</p>
 405         <table border="0" bgcolor="#E0E0E0" width="100%">
 406           <tr>
 407             <td>
 408               <pre class="PROGRAMLISTING">  os2build</pre>
 409             </td>
 410           </tr>
 411         </table>
 412         <p>You will find the WarpIN-installable executable in the <tt class="FILENAME">./files</tt> directory. Upload
 413         this anonymously to <tt class="FILENAME">uploads.sourceforge.net/incoming</tt>, create a release for it, and
 414         you're done. Use the release notes and Change Log from the source tarball package.</p>
 415       </div>
 416       <div class="SECT3">
 417         <h3 class="SECT3"><a name="NEWRELEASE-SOLARIS" id="NEWRELEASE-SOLARIS">6.3.5. Solaris</a></h3>
 418         <p>Login to Sourceforge's compilefarm via ssh:</p>
 419         <table border="0" bgcolor="#E0E0E0" width="100%">
 420           <tr>
 421             <td>
 422               <pre class="PROGRAMLISTING">  ssh cf.sourceforge.net</pre>
 423             </td>
 424           </tr>
 425         </table>
 426         <p>Choose the right operating system (not the Debian one). When logged in, <span class="emphasis"><i class=
 427         "EMPHASIS">make sure that you have freshly exported the right version into an empty directory</i></span>. (See
 428         "Building and releasing packages" above). Then run:</p>
 429         <table border="0" bgcolor="#E0E0E0" width="100%">
 430           <tr>
 431             <td>
 432               <pre class="PROGRAMLISTING">  cd current
 433   autoheader &amp;&amp; autoconf &amp;&amp; ./configure</pre>
 434             </td>
 435           </tr>
 436         </table>
 437         <p>Then run</p>
 438         <table border="0" bgcolor="#E0E0E0" width="100%">
 439           <tr>
 440             <td>
 441               <pre class="PROGRAMLISTING">  gmake solaris-dist</pre>
 442             </td>
 443           </tr>
 444         </table>
 445         <p>which creates a gzip'ed tar archive. Sadly, you cannot use <b class="COMMAND">make solaris-upload</b> on the
 446         Sourceforge machine (no ncftpput). You now have to manually upload the archive to Sourceforge's ftp server and
 447         release the file publicly. Use the release notes and Change Log from the source tarball package.</p>
 448       </div>
 449       <div class="SECT3">
 450         <h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id="NEWRELEASE-WINDOWS">6.3.6. Windows</a></h3>
 451         <p>Use the <a href="http://www.fruitbat.org/Cygwin/index.html#cygwincirca" target="_top">Cygwin Time
 452         Machine</a> to install the last 1.5 version of Cygwin. Run the following commands from within the Cygwin 1.5
 453         bash shell.</p>
 454         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 455         into an empty directory</i></span>. (See "Building and releasing packages" above). Then get the Windows setup
 456         module:</p>
 457         <table border="0" bgcolor="#E0E0E0" width="100%">
 458           <tr>
 459             <td>
 460               <pre class="PROGRAMLISTING">
 461               cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup</pre>
 462             </td>
 463           </tr>
 464         </table>
 465         <p>Then you can build the package. This is fully automated, and is controlled by <tt class=
 466         "FILENAME">winsetup/GNUmakefile</tt>. All you need to do is:</p>
 467         <table border="0" bgcolor="#E0E0E0" width="100%">
 468           <tr>
 469             <td>
 470               <pre class="PROGRAMLISTING">  cd winsetup
 471   make</pre>
 472             </td>
 473           </tr>
 474         </table>
 475         <p>Now you can manually rename <tt class="FILENAME">privoxy_setup.exe</tt> to <tt class=
 476         "FILENAME">privoxy_setup_X_Y_Z.exe</tt>, and upload it to SourceForge. When releasing the package on
 477         SourceForge, use the release notes and Change Log from the source tarball package.</p>
 478       </div>
 479       <div class="SECT3">
 480         <h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id="NEWRELEASE-DEBIAN">6.3.7. Debian</a></h3>
 481         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 482         into an empty directory</i></span>. (See "Building and releasing packages" above). Then add a log entry to
 483         <tt class="FILENAME">debian/changelog</tt>, if it is not already there, for example by running:</p>
 484         <table border="0" bgcolor="#E0E0E0" width="100%">
 485           <tr>
 486             <td>
 487               <pre class="PROGRAMLISTING">  debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</pre>
 488             </td>
 489           </tr>
 490         </table>
 491         <p>Then, run:</p>
 492         <table border="0" bgcolor="#E0E0E0" width="100%">
 493           <tr>
 494             <td>
 495               <pre class="PROGRAMLISTING">  dpkg-buildpackage -rfakeroot -us -uc -b</pre>
 496             </td>
 497           </tr>
 498         </table>
 499         <p>This will create <tt class="FILENAME">../privoxy_3.0.27-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
 500         upload the package to Sourceforge, simply issue</p>
 501         <table border="0" bgcolor="#E0E0E0" width="100%">
 502           <tr>
 503             <td>
 504               <pre class="PROGRAMLISTING">  make debian-upload</pre>
 505             </td>
 506           </tr>
 507         </table>
 508       </div>
 509       <div class="SECT3">
 510         <h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id="NEWRELEASE-MACOSX">6.3.8. Mac OS X</a></h3>
 511         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 512         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 513         <p>There are three modules available in the CVS repository for use on Mac OS X, though technically only two of
 514         them generate a release (the other can be used to install from source).</p>
 515         <div class="SECT4">
 516           <h4 class="SECT4"><a name="OS-X-OSXPACKAGEBUILDER-MODULE" id="OS-X-OSXPACKAGEBUILDER-MODULE">6.3.8.1.
 517           OSXPackageBuilder module</a></h4>
 518           <p>The OSXPackageBuilder module generates OS X installer packages supporting all Macs running OS X 10.4 and
 519           above. Obtain it from CVS as follows into a folder parallel to the exported privoxy source:</p>
 520           <table border="0" bgcolor="#E0E0E0" width="100%">
 521             <tr>
 522               <td>
 523                 <pre class="PROGRAMLISTING">
 524                 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co OSXPackageBuilder</pre>
 525               </td>
 526             </tr>
 527           </table>
 528           <p>The module contains complete instructions on its usage in the file <tt class="FILENAME">OS X Package
 529           Builder HOWTO.txt</tt>.</p>
 530           <p>Once the package(s) have been generated, you can then upload them directly to the Files section of the
 531           Sourceforge project in the Macintosh (OS X) folder. Each new version release of Privoxy should have a new
 532           subfolder created in which to store its files. Please ensure that the folder contains a readme file that
 533           makes it clear which package is for whichversion of OS X.</p>
 534         </div>
 535         <div class="SECT4">
 536           <h4 class="SECT4"><a name="OS-X-OSXSETUP-MODULE" id="OS-X-OSXSETUP-MODULE">6.3.8.2. osxsetup module
 537           (DEPRECATED)</a></h4>
 538           <p><span class="emphasis"><i class="EMPHASIS">This module is deprecated since the installer it generates
 539           places all Privoxy files in one folder in a non-standard location, and supports only Intel Macs running OS X
 540           10.6 or higher.</i></span></p>
 541           <p>Check out the module from CVS as follows into a folder parallel to the exported privoxy source:</p>
 542           <table border="0" bgcolor="#E0E0E0" width="100%">
 543             <tr>
 544               <td>
 545                 <pre class="PROGRAMLISTING">
 546                 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup</pre>
 547               </td>
 548             </tr>
 549           </table>
 550           <p>Then run:</p>
 551           <table border="0" bgcolor="#E0E0E0" width="100%">
 552             <tr>
 553               <td>
 554                 <pre class="PROGRAMLISTING">  cd osxsetup
 555   build</pre>
 556               </td>
 557             </tr>
 558           </table>
 559           <p>This will run <tt class="FILENAME">autoheader</tt>, <tt class="FILENAME">autoconf</tt> and <tt class=
 560           "FILENAME">configure</tt> as well as <tt class="FILENAME">make</tt>. Finally, it will copy over the necessary
 561           files to the ./osxsetup/files directory for further processing by <tt class="FILENAME">PackageMaker</tt>.</p>
 562           <p>Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package name to match the
 563           release, and hit the "Create package" button. If you specify ./Privoxy.pkg as the output package name, you
 564           can then create the distributable zip file with the command:</p>
 565           <table border="0" bgcolor="#E0E0E0" width="100%">
 566             <tr>
 567               <td>
 568                 <pre class="PROGRAMLISTING">  zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg</pre>
 569               </td>
 570             </tr>
 571           </table>
 572           <p>You can then upload this file directly to the Files section of the Sourceforge project in the Macintosh
 573           (OS X) folder. Each new version release of Privoxy should have a new subfolder created in which to store its
 574           files. Please ensure that the folder contains a readme file that makes it clear which version(s) of OS X the
 575           package supports.</p>
 576         </div>
 577         <div class="SECT4">
 578           <h4 class="SECT4"><a name="OS-X-MACSETUP-MODULE" id="OS-X-MACSETUP-MODULE">6.3.8.3. macsetup module</a></h4>
 579           <p>The macsetup module is ideal if you wish to build and install Privoxy from source on a single machine.</p>
 580           <p>Check out the module from CVS as follows into a folder parallel to the exported privoxy source:</p>
 581           <table border="0" bgcolor="#E0E0E0" width="100%">
 582             <tr>
 583               <td>
 584                 <pre class="PROGRAMLISTING">
 585                 cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co macsetup</pre>
 586               </td>
 587             </tr>
 588           </table>
 589           <p>The module contains complete instructions on its usage in its <tt class="FILENAME">README</tt> file. The
 590           end result will be the exported version of Privoxy installed on the build machine.</p>
 591         </div>
 592       </div>
 593       <div class="SECT3">
 594         <h3 class="SECT3"><a name="NEWRELEASE-FREEBSD" id="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</a></h3>
 595         <p>Update the www/privoxy port and submit a diff upstream. For details see the <a href=
 596         "https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/" target="_top">FreeBSD Porter's
 597         Handbook</a>.</p>
 598       </div>
 599     </div>
 600     <div class="SECT2">
 601       <h2 class="SECT2"><a name="RELEASING" id="RELEASING">6.4. Uploading and Releasing Your Package</a></h2>
 602       <p>After the package is ready, it is time to upload it to SourceForge, and go through the release steps. The
 603       upload is done via FTP:</p>
 604       <ul>
 605         <li>
 606           <p>Upload to: <a href="ftp://upload.sourceforge.net/incoming" target=
 607           "_top">ftp://upload.sourceforge.net/incoming</a></p>
 608         </li>
 609         <li>
 610           <p>user: <tt class="LITERAL">anonymous</tt></p>
 611         </li>
 612         <li>
 613           <p>password: <tt class="LITERAL">ijbswa-developers@lists.sourceforge.net</tt></p>
 614         </li>
 615       </ul>
 616       <p>Or use the <b class="COMMAND">make</b> targets as described above.</p>
 617       <p>Once this done go to <a href="https://sourceforge.net/project/admin/editpackages.php?group_id=11118" target=
 618       "_top">https://sourceforge.net/project/admin/editpackages.php?group_id=11118</a>, making sure you are logged in.
 619       Find your target platform in the second column, and click <tt class="LITERAL">Add Release</tt>. You will then
 620       need to create a new release for your package, using the format of <tt class="LITERAL">$VERSION
 621       ($CODE_STATUS)</tt>, e.g. <span class="emphasis"><i class="EMPHASIS">3.0.27 (beta)</i></span>.</p>
 622       <p>Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly
 623       uploaded packages in <span class="QUOTE">"Step 2. Add Files To This Release"</span>. Check the appropriate
 624       box(es). Remember at each step to hit the <span class="QUOTE">"Refresh/Submit"</span> buttons! You should now see
 625       your file(s) listed in Step 3. Fill out the forms with the appropriate information for your platform, being sure
 626       to hit <span class="QUOTE">"Update"</span> for each file. If anyone is monitoring your platform, check the
 627       <span class="QUOTE">"email"</span> box at the very bottom to notify them of the new package. This should do
 628       it!</p>
 629       <p>If you have made errors, or need to make changes, you can go through essentially the same steps, but select
 630       <tt class="LITERAL">Edit Release</tt>, instead of <tt class="LITERAL">Add Release</tt>.</p>
 631     </div>
 632     <div class="SECT2">
 633       <h2 class="SECT2"><a name="AFTERRELEASE" id="AFTERRELEASE">6.5. After the Release</a></h2>
 634       <p>When all (or: most of the) packages have been uploaded and made available, send an email to the <a href=
 635       "mailto:privoxy-announce@lists.privoxy.org" target="_top">announce mailing list</a>, Subject: "Version X.Y.Z
 636       available for download". Be sure to include the <a href=
 637       "https://sourceforge.net/project/showfiles.php?group_id=11118" target="_top">download location</a>, the release
 638       notes and the Changelog. Also, post an updated News item on the project page Sourceforge, and update the Home
 639       page and docs linked from the Home page (see below). Other news sites and release oriented sites, such as
 640       Freshmeat, should also be notified.</p>
 641     </div>
 642   </div>
 643   <div class="NAVFOOTER">
 644     <hr align="left" width="100%">
 645     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
 646       <tr>
 647         <td width="33%" align="left" valign="top"><a href="testing.html" accesskey="P">Prev</a></td>
 648         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
 649         <td width="33%" align="right" valign="top"><a href="webserver-update.html" accesskey="N">Next</a></td>
 650       </tr>
 651       <tr>
 652         <td width="33%" align="left" valign="top">Testing Guidelines</td>
 653         <td width="34%" align="center" valign="top">&nbsp;</td>
 654         <td width="33%" align="right" valign="top">Update the Webserver</td>
 655       </tr>
 656     </table>
 657   </div>
 658 </body>
 659 </html>