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