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