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