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=iso-8859-1">
  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">ssh</tt>, <tt class=
  35     "FILENAME">gmake</tt> (GNU's version of make), autoconf, git, a web browser.</p>
  36     <div class="SECT2">
  37       <h2 class="SECT2"><a name="VERSIONNUMBERS" id="VERSIONNUMBERS">6.1. Version numbers</a></h2>
  38       <p>First you need to determine which version number the release will have. <span class=
  39       "APPLICATION">Privoxy</span> version numbers consist of three numbers, separated by dots, like in X.Y.Z (e.g.
  40       3.0.0), where:</p>
  41       <ul>
  42         <li>
  43           <p>X, the version major, is rarely ever changed. Majors 1 and 2 were <span class=
  44           "APPLICATION">Junkbuster</span>, and 3 is the first stable <span class="APPLICATION">Privoxy</span>
  45           release.</p>
  46         </li>
  47         <li>
  48           <p>Y, the version minor, is increased for every release except for pure bug fix releases in which case only
  49           Z, the point or sub version, is increased.</p>
  50         </li>
  51         <li>
  52           <p>The point version is reset to zero when the minor changes.</p>
  53         </li>
  54       </ul>
  55     </div>
  56     <div class="SECT2">
  57       <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release</a></h2>
  58       <p>The following <span class="emphasis"><i class="EMPHASIS">must be done by one of the developers</i></span>
  59       prior to each new release.</p>
  60       <ul>
  61         <li>
  62           <p>Make sure that everybody who has worked on the code in the last couple of days has had a chance to yell
  63           <span class="QUOTE">"no!"</span> in case they have pending changes/fixes in their pipelines. Announce the
  64           freeze so that nobody will interfere with last minute changes.</p>
  65         </li>
  66         <li>
  67           <p>Update the code status (CODE_STATUS="xxx") in <tt class="FILENAME">configure.in</tt> to one of "alpha",
  68           "beta" or "stable".</p>
  69         </li>
  70         <li>
  71           <p>Rebuild configure and GNUMakefile to make sure the updated values are being used.</p>
  72           <table border="0" bgcolor="#E0E0E0" width="90%">
  73             <tr>
  74               <td>
  75                 <pre class="PROGRAMLISTING">  $ autoheader &#38;&#38; autoconf     # rebuild configure
  76   $ ./configure                # rebuild GNUmakefile</pre>
  77               </td>
  78             </tr>
  79           </table>
  80         </li>
  81         <li>
  82           <p><b class="COMMAND">make dok-release</b> to update the sgml documentation source files.</p>
  83         </li>
  84         <li>
  85           <p>If action file processing has changed and is not backward-compatible, make sure the
  86           "for-privoxy-version=x.y.z" minimum version number in <tt class="FILENAME">default.action.master</tt> has
  87           been updated:</p>
  88           <table border="0" bgcolor="#E0E0E0" width="90%">
  89             <tr>
  90               <td>
  91                 <pre class="PROGRAMLISTING">  {{settings}}
  92   #############################################################################
  93   #MASTER# COMMENT: The minimum Privoxy version:
  94   for-privoxy-version=3.0.11</pre>
  95               </td>
  96             </tr>
  97           </table>
  98         </li>
  99         <li>
 100           <p>Create the change log:</p>
 101           <table border="0" bgcolor="#E0E0E0" width="90%">
 102             <tr>
 103               <td>
 104                 <pre class="PROGRAMLISTING">  $ git tag
 105   #   to see the tags
 106   $ git log [last release tag]..master &gt; /tmp/log
 107   #   get the commit log since the last release
 108   $ utils/makeChangeLog /tmp/log &gt; /tmp/change.log
 109   #   reformat the commit log</pre>
 110               </td>
 111             </tr>
 112           </table>
 113           <p>Edit <tt class="FILENAME">/tmp/change.log</tt> to remove trivial changes and group the changes under
 114           general headings like:</p>
 115           <table border="0" bgcolor="#E0E0E0" width="90%">
 116             <tr>
 117               <td>
 118                 <pre class="PROGRAMLISTING">  - Bug fixes:
 119   - Action file improvements:
 120   - Filter file improvements:
 121   - General improvements:
 122   - Documentation improvements:
 123   - Build system improvements:
 124   - Code cleanups:
 125   - Privoxy-Log-Parser:
 126   - Privoxy-Regression-Test:</pre>
 127               </td>
 128             </tr>
 129           </table>
 130           <p>Add the contents of <tt class="FILENAME">/tmp/change.log</tt> to the start of <tt class=
 131           "FILENAME">ChangeLog</tt> and re-create <tt class="FILENAME">doc/source/changelog.sgml</tt>:</p>
 132           <table border="0" bgcolor="#E0E0E0" width="90%">
 133             <tr>
 134               <td>
 135                 <pre class=
 136                 "PROGRAMLISTING">  $ utils/changelog2doc.pl /tmp/change.log &gt;| doc/source/changelog.sgml</pre>
 137               </td>
 138             </tr>
 139           </table>
 140         </li>
 141         <li>
 142           <p>All developers should look at the <tt class="FILENAME">ChangeLog</tt> and make sure noteworthy changes are
 143           referenced.</p>
 144         </li>
 145         <li>
 146           <p>Update the announcement at <tt class="FILENAME">doc/webserver/announce.txt</tt>.</p>
 147         </li>
 148         <li>
 149           <p>All documentation should be rebuilt:</p>
 150           <table border="0" bgcolor="#E0E0E0" width="90%">
 151             <tr>
 152               <td>
 153                 <pre class="PROGRAMLISTING">  $ make man
 154   $ make dok
 155   $ make dok-man
 156   $ make dok-tidy
 157   $ make config-file</pre>
 158               </td>
 159             </tr>
 160           </table>Finished docs should be then be committed to Git (for those without the ability to build these). Some
 161           docs may require rather obscure processing tools. <tt class="FILENAME">config</tt>, the man page (and the
 162           html version of the man page) fall in this category. README, the man page, AUTHORS, and config should all
 163           also be committed to Git for other packagers. The formal docs should be uploaded to the webserver. See the
 164           section <a href="webserver-update.html" target="_top">"Updating the webserver"</a> in this manual for
 165           details.
 166         </li>
 167         <li>
 168           <p><span class="emphasis"><i class="EMPHASIS">Commit all files that were changed in the above
 169           steps!</i></span></p>
 170         </li>
 171         <li>
 172           <p>The <i class="CITETITLE">User Manual</i> is also used for context sensitive help for the CGI editor. This
 173           is version sensitive, so that the user will get appropriate help for his/her release. So with each release a
 174           fresh version should be uploaded to the webserver (this is in addition to the main <i class="CITETITLE">User
 175           Manual</i> link from the main page since we need to keep manuals for various versions available). The CGI
 176           pages will link to something like <tt class="LITERAL">https://www.privoxy.org/$(VERSION)/user-manual/</tt>.
 177           This needs to be updated for each new release and is done with the <span class="QUOTE">"webserver"</span>
 178           target.</p>
 179         </li>
 180         <li>
 181           <p>Tag all files in Git with the version number with <span class="QUOTE">"<b class="COMMAND">git tag -s
 182           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>
 183         </li>
 184         <li>
 185           <p>Push the tag to the remote with <span class="QUOTE">"<b class="COMMAND">git push origin
 186           v_X_Y_Z</b>"</span>.</p>
 187         </li>
 188         <li>
 189           <p>On the webserver, copy the user manual to a new top-level directory called <tt class=
 190           "FILENAME">X.Y.Z</tt>. This ensures that help links from the CGI pages, which have the version as a prefix,
 191           will go into the right version of the manual. If this is a development branch release, also symlink
 192           <tt class="FILENAME">X.Y.(Z-1)</tt> to <tt class="FILENAME">X.Y.Z</tt> and <tt class=
 193           "FILENAME">X.Y.(Z+1)</tt> to <tt class="FILENAME">.</tt> (i.e. dot).</p>
 194         </li>
 195       </ul>
 196     </div>
 197     <div class="SECT2">
 198       <h2 class="SECT2"><a name="THERELEASE" id="THERELEASE">6.3. Building and Releasing the Packages</a></h2>
 199       <p>Now the individual packages can be built and released. Note that for GPL reasons the first package to be
 200       released is always the source tarball.</p>
 201       <p>For <span class="emphasis"><i class="EMPHASIS">all</i></span> types of packages, including the source tarball,
 202       <span class="emphasis"><i class="EMPHASIS">you must make sure that you build from clean sources by exporting the
 203       right version from Git into an empty directory</i></span> (just press return when asked for a password):</p>
 204       <table border="0" bgcolor="#E0E0E0" width="100%">
 205         <tr>
 206           <td>
 207             <pre class="PROGRAMLISTING">  mkdir dist # delete or choose different name if it already exists
 208   cd dist
 209   git clone https://www.privoxy.org/git/privoxy.git
 210   cd privoxy
 211   git checkout v_X_Y_Z</pre>
 212           </td>
 213         </tr>
 214       </table>
 215       <p><span class="emphasis"><i class="EMPHASIS">Do NOT change</i></span> a single bit, including, but not limited
 216       to version information after export from Git. This is to make sure that all release packages, and with them, all
 217       future bug reports, are based on exactly the same code.</p>
 218       <div class="WARNING">
 219         <table class="WARNING" border="1" width="100%">
 220           <tr>
 221             <td align="center"><b>Warning</b></td>
 222           </tr>
 223           <tr>
 224             <td align="left">
 225               <p>Every significant release of Privoxy has included at least one package that either had incorrect
 226               versions of files, missing files, or incidental leftovers from a previous build process that gave unknown
 227               numbers of users headaches to try to figure out what was wrong. PLEASE, make sure you are using pristene
 228               sources, and are following the prescribed process!</p>
 229             </td>
 230           </tr>
 231         </table>
 232       </div>
 233       <p>Please find additional instructions for the source tarball and the individual platform dependent binary
 234       packages below. And details on the Sourceforge release process below that.</p>
 235       <div class="SECT3">
 236         <h3 class="SECT3"><a name="PACK-GUIDELINES" id="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</a></h3>
 237         <p>Please keep these general guidelines in mind when putting together your package. These apply to <span class=
 238         "emphasis"><i class="EMPHASIS">all</i></span> platforms!</p>
 239         <ul>
 240           <li>
 241             <p><span class="APPLICATION">Privoxy</span> <span class="emphasis"><i class="EMPHASIS">requires</i></span>
 242             write access to: all <tt class="FILENAME">*.action</tt> files, all logfiles, and the <tt class=
 243             "FILENAME">trust</tt> file. You will need to determine the best way to do this for your platform.</p>
 244           </li>
 245           <li>
 246             <p>Please include up to date documentation. At a bare minimum:</p>
 247             <table border="0">
 248               <tbody>
 249                 <tr>
 250                   <td><tt class="FILENAME">LICENSE</tt> (top-level directory)</td>
 251                 </tr>
 252               </tbody>
 253             </table>
 254             <table border="0">
 255               <tbody>
 256                 <tr>
 257                   <td><tt class="FILENAME">README</tt> (top-level directory)</td>
 258                 </tr>
 259               </tbody>
 260             </table>
 261             <table border="0">
 262               <tbody>
 263                 <tr>
 264                   <td><tt class="FILENAME">AUTHORS</tt> (top-level directory)</td>
 265                 </tr>
 266               </tbody>
 267             </table>
 268             <table border="0">
 269               <tbody>
 270                 <tr>
 271                   <td><tt class="FILENAME">man page</tt> (top-level directory, Unix-like platforms only)</td>
 272                 </tr>
 273               </tbody>
 274             </table>
 275             <table border="0">
 276               <tbody>
 277                 <tr>
 278                   <td><tt class="FILENAME">The User Manual</tt> (doc/webserver/user-manual/)</td>
 279                 </tr>
 280               </tbody>
 281             </table>
 282             <table border="0">
 283               <tbody>
 284                 <tr>
 285                   <td><tt class="FILENAME">FAQ</tt> (doc/webserver/faq/)</td>
 286                 </tr>
 287               </tbody>
 288             </table>
 289             <p>Also suggested: <tt class="FILENAME">Developer Manual</tt> (doc/webserver/developer-manual) and
 290             <tt class="FILENAME">ChangeLog</tt> (top-level directory). <tt class="FILENAME">FAQ</tt> and the manuals
 291             are HTML docs.</p>
 292             <p>The documentation has been designed such that the manuals are linked to each other from parallel
 293             directories, and should be packaged that way. <tt class="FILENAME">privoxy-index.html</tt> can also be
 294             included and can serve as a focal point for docs and other links of interest (and possibly renamed to
 295             <tt class="FILENAME">index.html</tt>). This should be one level up from the manuals. There is a link also
 296             on this page to an HTMLized version of the man page. To avoid 404 for this, it is in Git as <tt class=
 297             "FILENAME">doc/webserver/man-page/privoxy-man-page.html</tt>, and should be included along with the
 298             manuals. There is also a css stylesheets that can be included for better presentation: <tt class=
 299             "FILENAME">p_doc.css</tt>. This should be in the same directory with <tt class=
 300             "FILENAME">privoxy-index.html</tt>, (i.e. one level up from the manual directories).</p>
 301           </li>
 302           <li>
 303             <p><tt class="FILENAME">user.action</tt> and <tt class="FILENAME">user.filter</tt> are designed for local
 304             preferences. Make sure these do not get overwritten! <tt class="FILENAME">config</tt> should not be
 305             overwritten either. This has especially important configuration data in it. <tt class="FILENAME">trust</tt>
 306             should be left in tact as well.</p>
 307           </li>
 308           <li>
 309             <p>Other configuration files (<tt class="FILENAME">default.action</tt>, <tt class=
 310             "FILENAME">regression-tests.action</tt> and <tt class="FILENAME">default.filter</tt>) should be installed
 311             as the new defaults, but all previously installed configuration files should be preserved as backups. This
 312             is just good manners :-) These files are likely to change between releases and contain important new
 313             features and bug fixes.</p>
 314           </li>
 315           <li>
 316             <p>Please check platform specific notes in this doc, if you haven't done <span class=
 317             "QUOTE">"Privoxy"</span> packaging before for other platform specific issues. Conversely, please add any
 318             notes that you know are important for your platform (or contact one of the doc maintainers to do this if
 319             you can't).</p>
 320           </li>
 321           <li>
 322             <p>Packagers should do a <span class="QUOTE">"clean"</span> install of their package after building it. So
 323             any previous installs should be removed first to ensure the integrity of the newly built package. Then run
 324             the package for a while to make sure there are no obvious problems, before uploading.</p>
 325           </li>
 326         </ul>
 327       </div>
 328       <div class="SECT3">
 329         <h3 class="SECT3"><a name="NEWRELEASE-TARBALL" id="NEWRELEASE-TARBALL">6.3.2. Source Tarball</a></h3>
 330         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 331         into an empty directory</i></span>. (See "Building and releasing packages" above). Then run from that
 332         directory:</p>
 333         <table border="0" bgcolor="#E0E0E0" width="100%">
 334           <tr>
 335             <td>
 336               <pre class="PROGRAMLISTING">  autoheader &#38;&#38; autoconf &#38;&#38; ./configure</pre>
 337             </td>
 338           </tr>
 339         </table>
 340         <p>Then do:</p>
 341         <table border="0" bgcolor="#E0E0E0" width="100%">
 342           <tr>
 343             <td>
 344               <pre class="PROGRAMLISTING">  make tarball-dist</pre>
 345             </td>
 346           </tr>
 347         </table>
 348       </div>
 349       <div class="SECT3">
 350         <h3 class="SECT3"><a name="NEWRELEASE-WINDOWS" id="NEWRELEASE-WINDOWS">6.3.3. Windows</a></h3>
 351         <p>Note that the docbook generated files might need some hand editing, so the Windows build makefile does not
 352         rebuild the docs.</p>
 353         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 354         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 355         <p>Check that you have the current versions of the <a href=
 356         "https://sourceforge.net/projects/nsis/files/NSIS%203/" target="_top">NSIS installer</a>, <a href=
 357         "https://sourceforge.net/projects/pcre/files/pcre/" target="_top">PCRE library</a>, <a href=
 358         "https://github.com/Mbed-TLS/mbedtls/tags" target="_top">MBED TLS library</a>, <a href=
 359         "https://github.com/google/brotli/releases" target="_top">Brotli library</a>, and that the <span class=
 360         "emphasis"><i class="EMPHASIS">MAKENSIS</i></span> evar in <tt class="FILENAME">windows/GNUMakefile</tt> points
 361         to the NSIS installer program. (See the <a href="../user-manual/installation.html#WINBUILD-CYGWIN" target=
 362         "_top"><span class="emphasis"><i class="EMPHASIS">Building from Source / Windows</i></span></a> section of the
 363         User Manual for details.)</p>
 364         <p>Then you can build the package. This is fully automated, and is controlled by <tt class=
 365         "FILENAME">windows/GNUmakefile</tt>. All you need to do is:</p>
 366         <table border="0" bgcolor="#E0E0E0" width="100%">
 367           <tr>
 368             <td>
 369               <pre class="PROGRAMLISTING">  cd windows
 370   make</pre>
 371             </td>
 372           </tr>
 373         </table>
 374         <p>Now you can manually rename <tt class="FILENAME">privoxy_setup.exe</tt> to <tt class=
 375         "FILENAME">privoxy_setup_X.Y.Z.exe</tt>, and the <tt class="FILENAME">build</tt> directory to <tt class=
 376         "FILENAME">privoxy_X.Y.Z</tt>. Create a .zip file of the newly renamed <tt class="FILENAME">privoxy_X.Y.Z</tt>
 377         directory, GPG sign the installer and zip file,</p>
 378         <table border="0" bgcolor="#E0E0E0" width="100%">
 379           <tr>
 380             <td>
 381               <pre class="PROGRAMLISTING">  gpg --armor --detach --sign <tt class=
 382               "FILENAME">privoxy_setup_X.Y.Z.exe</tt>
 383   gpg --armor --detach --sign <tt class="FILENAME">privoxy_X.Y.Z.zip</tt></pre>
 384             </td>
 385           </tr>
 386         </table>
 387         <p>and upload the files to SourceForge.</p>
 388         <p>When releasing the package on SourceForge, use the release notes and Change Log from the source tarball
 389         package.</p>
 390       </div>
 391       <div class="SECT3">
 392         <h3 class="SECT3"><a name="NEWRELEASE-DEBIAN" id="NEWRELEASE-DEBIAN">6.3.4. Debian</a></h3>
 393         <p>Using git-buildpackage we start with a clone of the last Debian version:</p>
 394         <table border="0" bgcolor="#E0E0E0" width="100%">
 395           <tr>
 396             <td>
 397               <pre class="PROGRAMLISTING">  gbp clone https://salsa.debian.org/debian/privoxy.git
 398   cd privoxy</pre>
 399             </td>
 400           </tr>
 401         </table>
 402         <p>or if the repository is already there</p>
 403         <table border="0" bgcolor="#E0E0E0" width="100%">
 404           <tr>
 405             <td>
 406               <pre class="PROGRAMLISTING">  cd privoxy
 407   gbp pull</pre>
 408             </td>
 409           </tr>
 410         </table>
 411         <p>Now import the newly released upstream tarball via debian/watch file:</p>
 412         <table border="0" bgcolor="#E0E0E0" width="100%">
 413           <tr>
 414             <td>
 415               <pre class="PROGRAMLISTING">  gbp import-orig --uscan</pre>
 416             </td>
 417           </tr>
 418         </table>
 419         <p>Next update all Debian quilt patches to the new version:</p>
 420         <table border="0" bgcolor="#E0E0E0" width="100%">
 421           <tr>
 422             <td>
 423               <pre class="PROGRAMLISTING">  while quilt push; do quilt refresh; done</pre>
 424             </td>
 425           </tr>
 426         </table>
 427         <p>If some patch is no longer required (because it is already merged upstream), it can be removed using</p>
 428         <table border="0" bgcolor="#E0E0E0" width="100%">
 429           <tr>
 430             <td>
 431               <pre class="PROGRAMLISTING">  quilt delete XX_patchname.patch
 432   git rm debian/patches/XX_patchname.patch</pre>
 433             </td>
 434           </tr>
 435         </table>
 436         <p>If the patch needs modification, you can apply, edit and update it with</p>
 437         <table border="0" bgcolor="#E0E0E0" width="100%">
 438           <tr>
 439             <td>
 440               <pre class="PROGRAMLISTING">  quilt push -f
 441   quilt edit some_file
 442   quilt refresh</pre>
 443             </td>
 444           </tr>
 445         </table>
 446         <p>until</p>
 447         <table border="0" bgcolor="#E0E0E0" width="100%">
 448           <tr>
 449             <td>
 450               <pre class="PROGRAMLISTING">  while quilt push; do quilt refresh; done</pre>
 451             </td>
 452           </tr>
 453         </table>
 454         <p>succeeds. Then you can</p>
 455         <table border="0" bgcolor="#E0E0E0" width="100%">
 456           <tr>
 457             <td>
 458               <pre class="PROGRAMLISTING">  quilt pop -a</pre>
 459             </td>
 460           </tr>
 461         </table>
 462         <p>Now add a new entry to the debian/changelog representing the new version:</p>
 463         <table border="0" bgcolor="#E0E0E0" width="100%">
 464           <tr>
 465             <td>
 466               <pre class="PROGRAMLISTING">  dch -v 4.0.0-1</pre>
 467             </td>
 468           </tr>
 469         </table>
 470         <p>and describe what you did before and don't forget to git commit all changes.</p>
 471         <p>Now you can build the package on the local machine using</p>
 472         <table border="0" bgcolor="#E0E0E0" width="100%">
 473           <tr>
 474             <td>
 475               <pre class="PROGRAMLISTING">  gbp buildpackage -us -uc</pre>
 476             </td>
 477           </tr>
 478         </table>
 479         <p>You should check for warnings using</p>
 480         <table border="0" bgcolor="#E0E0E0" width="100%">
 481           <tr>
 482             <td>
 483               <pre class="PROGRAMLISTING">  lintian -iI ../build-area/privoxy_4.0.0-1_amd64.changes</pre>
 484             </td>
 485           </tr>
 486         </table>
 487         <p>Maybe rebuild the package in different defined cowbuilder environments like</p>
 488         <table border="0" bgcolor="#E0E0E0" width="100%">
 489           <tr>
 490             <td>
 491               <pre class=
 492               "PROGRAMLISTING">  sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_4.0.0-1.dsc</pre>
 493             </td>
 494           </tr>
 495         </table>
 496         <p>And try to run autopackage testing suite on the result:</p>
 497         <table border="0" bgcolor="#E0E0E0" width="100%">
 498           <tr>
 499             <td>
 500               <pre class=
 501               "PROGRAMLISTING">  autopkgtest /var/cache/pbuilder/result/privoxy_4.0.0-1_amd64.changes -s -- schroot sid</pre>
 502             </td>
 503           </tr>
 504         </table>
 505         <p>Or just push the changes to salsa.debian.org, where a CI pipeline is defined for the package, that builds
 506         and tests it.</p>
 507         <p>If everything is okay, run cowbuilder with i386 and amd64 environments for current Debian stable release and
 508         build privoxy_4.0.0-1_i386.deb and privoxy_4.0.0-1_amd64.deb. Then sign both files:</p>
 509         <table border="0" bgcolor="#E0E0E0" width="100%">
 510           <tr>
 511             <td>
 512               <pre class="PROGRAMLISTING">  gpg --detach-sign --armor privoxy_4.0.0-1_i386.deb
 513   gpg --detach-sign --armor privoxy_4.0.0-1_amd64.deb</pre>
 514             </td>
 515           </tr>
 516         </table>
 517         <p>Create a README file containing the recent block from debian/changelog and upload the two packages, the two
 518         signatures and the README to a freshly created folder below
 519         https://sourceforge.net/projects/ijbswa/files/Debian/</p>
 520         <div class="SECT4">
 521           <h4 class="SECT4"><a name="SNAPSHOT-DEBIAN" id="SNAPSHOT-DEBIAN">6.3.4.1. Debian GIT Snapshot</a></h4>
 522           <p>For building just a git snapshot build the following workflow may be useful. First create a build
 523           environment, for this you may have to run the following commands:</p>
 524           <table border="0" bgcolor="#E0E0E0" width="100%">
 525             <tr>
 526               <td>
 527                 <pre class="PROGRAMLISTING">  sudo apt install build-essential devscripts
 528   sudo apt-get build-dep privoxy</pre>
 529               </td>
 530             </tr>
 531           </table>
 532           <p>After this enter the checked out privoxy git tree and check that all (new) build dependencies are met:</p>
 533           <table border="0" bgcolor="#E0E0E0" width="100%">
 534             <tr>
 535               <td>
 536                 <pre class="PROGRAMLISTING">  dpkg-checkbuilddeps</pre>
 537               </td>
 538             </tr>
 539           </table>
 540           <p>If something is missing, just add it using</p>
 541           <table border="0" bgcolor="#E0E0E0" width="100%">
 542             <tr>
 543               <td>
 544                 <pre class="PROGRAMLISTING">  sudo apt install foobar</pre>
 545               </td>
 546             </tr>
 547           </table>
 548           <p>Now you may update debian/changelog, especially the version number using</p>
 549           <table border="0" bgcolor="#E0E0E0" width="100%">
 550             <tr>
 551               <td>
 552                 <pre class="PROGRAMLISTING">  dch</pre>
 553               </td>
 554             </tr>
 555           </table>
 556           <p>and finally build the package:</p>
 557           <table border="0" bgcolor="#E0E0E0" width="100%">
 558             <tr>
 559               <td>
 560                 <pre class="PROGRAMLISTING">  debuild -us -uc -b</pre>
 561               </td>
 562             </tr>
 563           </table>
 564           <p>If everything went okay, you may find the resulting Debian package in the parent directory.</p>
 565           <p>You may want to clean up the build tree using</p>
 566           <table border="0" bgcolor="#E0E0E0" width="100%">
 567             <tr>
 568               <td>
 569                 <pre class="PROGRAMLISTING">  debian/rules clean</pre>
 570               </td>
 571             </tr>
 572           </table>
 573           <p>And maybe repair some artefacts using one or both of the following commands:</p>
 574           <table border="0" bgcolor="#E0E0E0" width="100%">
 575             <tr>
 576               <td>
 577                 <pre class="PROGRAMLISTING">  git reset --hard
 578   git clean -fd</pre>
 579               </td>
 580             </tr>
 581           </table>
 582         </div>
 583       </div>
 584       <div class="SECT3">
 585         <h3 class="SECT3"><a name="NEWRELEASE-MACOSX" id="NEWRELEASE-MACOSX">6.3.5. macOS / OS X</a></h3>
 586         <p>First, <span class="emphasis"><i class="EMPHASIS">make sure that you have freshly exported the right version
 587         into an empty directory</i></span>. (See "Building and releasing packages" above).</p>
 588         <p>The OSXPackageBuilder module can generate OS X installer packages supporting all Macs running OS X 10.4 and
 589         above. Obtain it from Git as follows into a folder parallel to the exported privoxy source:</p>
 590         <table border="0" bgcolor="#E0E0E0" width="100%">
 591           <tr>
 592             <td>
 593               <pre class="PROGRAMLISTING">  git clone ssh://git@git.privoxy.org:23/git/OSXPackageBuilder.git</pre>
 594             </td>
 595           </tr>
 596         </table>
 597         <p>The module contains complete instructions on its usage in the file <tt class="FILENAME">OS X Package Builder
 598         HOWTO.txt</tt>.</p>
 599         <p>Once the package(s) have been generated, you can then upload them directly to the Files section of the
 600         Sourceforge project in the Macintosh (OS X) folder. Each new version release of Privoxy should have a new
 601         subfolder created in which to store its files. Please ensure that the folder contains a readme file that makes
 602         it clear which package is for which version of OS X.</p>
 603       </div>
 604       <div class="SECT3">
 605         <h3 class="SECT3"><a name="NEWRELEASE-FREEBSD" id="NEWRELEASE-FREEBSD">6.3.6. FreeBSD</a></h3>
 606         <p>Update the www/privoxy port and submit a diff upstream. For details see the <a href=
 607         "https://www.freebsd.org/doc/en_US.ISO8859-1/books/porters-handbook/" target="_top">FreeBSD Porter's
 608         Handbook</a>.</p>
 609       </div>
 610     </div>
 611     <div class="SECT2">
 612       <h2 class="SECT2"><a name="RELEASING" id="RELEASING">6.4. Uploading and Releasing Your Package</a></h2>
 613       <p>After the package is ready, it is time to upload it and go through the release steps. The upload is done at
 614       <a href="https://sourceforge.net/projects/ijbswa/upload/" target="_top">SourceForge</a> after logging in.</p>
 615       <p>Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly
 616       uploaded packages in <span class="QUOTE">"Step 2. Add Files To This Release"</span>. Check the appropriate
 617       box(es). Remember at each step to hit the <span class="QUOTE">"Refresh/Submit"</span> buttons! You should now see
 618       your file(s) listed in Step 3. Fill out the forms with the appropriate information for your platform, being sure
 619       to hit <span class="QUOTE">"Update"</span> for each file. If anyone is monitoring your platform, check the
 620       <span class="QUOTE">"email"</span> box at the very bottom to notify them of the new package. This should do
 621       it!</p>
 622       <p>If you have made errors, or need to make changes, you can go through essentially the same steps, but select
 623       <tt class="LITERAL">Edit Release</tt>, instead of <tt class="LITERAL">Add Release</tt>.</p>
 624     </div>
 625     <div class="SECT2">
 626       <h2 class="SECT2"><a name="UPDATE-RSS-FEED" id="UPDATE-RSS-FEED">6.5. Updating the RSS feed</a></h2>
 627       <p>Once the packages are uploaded to SourceForge they should be mirrored on the Privoxy websites (<a href=
 628       "https://www.privoxy.org/" target="_top">https://www.privoxy.org/</a> and <a href=
 629       "http://l3tczdiiwoo63iwxty4lhs6p7eaxop5micbn7vbliydgv63x5zrrrfyd.onion/" target=
 630       "_top">http://l3tczdiiwoo63iwxty4lhs6p7eaxop5micbn7vbliydgv63x5zrrrfyd.onion/</a>). This is usually done by
 631       Fabian who uses a couple of shell functions for this that aren't documented or published yet.</p>
 632       <p>Once the packages are uploaded to the mirror the RSS feed has to be regenerated with a command like:</p>
 633       <table border="0" bgcolor="#E0E0E0" width="100%">
 634         <tr>
 635           <td>
 636             <pre class=
 637             "PROGRAMLISTING">       fk@t520 ~/git/privoxy $utils/create-package-feed.pl /tank/backups/sourceforge/frs/project/ijbswa/ doc/webserver/feeds/privoxy-releases.xm
 638       </pre>
 639           </td>
 640         </tr>
 641       </table>
 642       <p>The updated RSS feed then has to be uploaded to the SourceForge webserver and mirrored on the Privoxy websites
 643       again. This, too, is usually done by Fabian with undocumented and unpublished shell functions.</p>
 644     </div>
 645     <div class="SECT2">
 646       <h2 class="SECT2"><a name="AFTERRELEASE" id="AFTERRELEASE">6.6. After the Release</a></h2>
 647       <p>When all (or: most of the) packages have been uploaded and made available, send an email to the <a href=
 648       "mailto:privoxy-announce@lists.privoxy.org" target="_top">announce mailing list</a>, Subject: "Announcing Privoxy
 649       X.Y.Z $CODE_STATUS". Be sure to include the <a href="https://sourceforge.net/projects/ijbswa/files/" target=
 650       "_top">download location</a>, the release notes and the Changelog. Also, post an updated News item on the project
 651       page Sourceforge, and update the Home page and docs linked from the Home page (see below). Other news sites and
 652       release oriented sites, such as Freshmeat, should also be notified.</p>
 653       <p>Then update the source code for the next version to be released:</p>
 654       <ul>
 655         <li>
 656           <p>Increment the version number and change the code status to "UNRELEASED" in <tt class=
 657           "FILENAME">configure.in</tt></p>
 658         </li>
 659         <li>
 660           <p>Rebuild configure (<span class="QUOTE">"<b class="COMMAND">autoheader &#38;&#38; autoconf</b>"</span>) and
 661           GNUMakefile (<span class="QUOTE">"<b class="COMMAND">./configure</b>"</span>)</p>
 662         </li>
 663         <li>
 664           <p><span class="QUOTE">"<b class="COMMAND">make dok-release</b>"</span> to update the sgml documentation
 665           source files.</p>
 666         </li>
 667         <li>
 668           <p>Commit all your changes.</p>
 669         </li>
 670       </ul>
 671     </div>
 672   </div>
 673   <div class="NAVFOOTER">
 674     <hr align="left" width="100%">
 675     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
 676       <tr>
 677         <td width="33%" align="left" valign="top"><a href="testing.html" accesskey="P">Prev</a></td>
 678         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
 679         <td width="33%" align="right" valign="top"><a href="webserver-update.html" accesskey="N">Next</a></td>
 680       </tr>
 681       <tr>
 682         <td width="33%" align="left" valign="top">Testing Guidelines</td>
 683         <td width="34%" align="center" valign="top">&nbsp;</td>
 684         <td width="33%" align="right" valign="top">Update the Webserver</td>
 685       </tr>
 686     </table>
 687   </div>
 688 </body>
 689 </html>