Releasing a New Version

Prev 8. Releasing a New Version6. Releasing a New Version

When we release versions of

The following programs are required to follow this process: - ncftpput (ncftp), The following programs are required to follow this process: + scp, ssh (ssh), +>ssh, gmake (GNU's version of make), autoconf, cvs. +> (GNU's version of make), autoconf, git, + a web browser.

8.1. Version numbers6.1. Version numbers

First you need to determine which version number the release will have. +> First you need to determine which version number the release will have. Privoxy version numbers consist of three numbers, - separated by dots, like in X.Y.Z, where: -

X, the version major, is rarely ever changed. It is increased by one if turning a development branch into stable substantially changes the functionality, - user interface or configuration syntax. Majors 1 and 2 were + user interface or configuration syntax. Majors 1 and 2 were Junkbuster, and 3 will be the first stable +>, and 3 is the first stable Privoxy
Y, the version minor, represents the branch within the major version. +> + Y, the version minor, represents the branch within the major version. At any point in time, there are two branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is - being added and only bugfixes are made, and 2N+1, the development branch, in + being added and only bug-fixes are made, and 2N+1, the development branch, in which the further development of Privoxy
Z, the point or sub version, represents a release of the software within a branch. - It is therefore incremented immediately before each code freeze. - In development branches, only the even point versions correspond to actual releases, - while the odd ones denote the evolving state of the sources on CVS in between. - It follows that Z is odd on CVS in development branches most of the time. There, it gets - increased to an even number immediately before a code freeze, and is increased to an odd - number again immediately thereafter. - This ensures that builds from CVS snapshots are easily distinguished from released versions. + It is therefore incremented immediately after each software release. + The point version is reset to zero when the minor changes.
Stable branches work a little differently, since there should be + little to no development happening in such branches. Remember, + only bugfixes, which presumably should have had some testing + before being committed. Stable branches will then have their + version reported as 0.0.0, during that period + between releases when changes are being added. This is to denote + that this code is not for release. Then + as the release nears, the version is bumped according: e.g. + 3.0.1 -> 0.0.0 -> 3.0.2. +

In summary, the main Git trunk is the development branch where new + features are being worked on for the next stable series. This should + almost always be where the most activity takes place. There is always at + least one stable branch from the trunk, e.g now it is + 3.0, which is only used to release stable versions. + Once the initial *.0 release of the stable branch has been done, then as a + rule, only bugfixes that have had prior testing should be committed to + the stable branch. Once there are enough bugfixes to justify a new + release, the version of this branch is again incremented Example: 3.0.0 + -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable + branch. 3.1.x is currently the main trunk, and where work on 3.2.x is + taking place. If any questions, please post to the devel list + before committing to a stable branch! +

Developers should remember too that if they commit a bugfix to the stable + branch, this will more than likely require a separate submission to the + main trunk, since these are separate development trees within Git. If you + are working on both, then this would require at least two separate check + outs (i.e main trunk, and the stable release branch, + which is v_3_0_branch at the moment).

8.2. Before the Release: Freeze6.2. Before the Release

The following The following must be done by one of the developers prior to each new release.

in case they have pending changes/fixes in their pipelines. Announce the freeze so that nobody will interfere with last minute changes. -
Increment the version number (point from odd to even in development - branches!) in Update the code status (CODE_STATUS="xxx") in configure.in. +> to one of + "alpha", "beta" or "stable". +
Rebuild configure and GNUMakefile to make sure the updated values are being used. +

  $ autoheader && autoconf     # rebuild configure
+  $ ./configure                # rebuild GNUmakefile

make dok-release to update the sgml documentation source files.

If If action file processing has changed and is not backward-compatible, + make sure the "for-privoxy-version=x.y.z" minimum version number in + default.action has changed since last - release (i.e. software release or standalone actions file release), - bump up its version info to A.B in this line: +>default.action.master has been updated: +

  {{settings}}
+  #############################################################################
+  #MASTER# COMMENT: The minimum Privoxy version:
+  for-privoxy-version=3.0.11

Create the change log:

  $ 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

- Edit /tmp/change.log to remove trivial + changes and group the changes under general headings like: + {+add-header{X-Actions-File-Version: A.B} -filter -no-popups} - Bug fixes: + - Action file improvements: + - Filter file improvements: + - General improvements: + - Documentation improvements: + - Build system improvements: + - Code cleanups: + - Privoxy-Log-Parser: + - Privoxy-Regression-Test: +>

Add the contents of /tmp/change.log to the + start of ChangeLog and re-create + doc/source/changelog.sgml: +

  $ utils/changelog2doc.pl /tmp/change.log >| doc/source/changelog.sgml

All developers should look at the ChangeLog and + make sure noteworthy changes are referenced.

- Then change the version info in doc/webserver/actions/index.php, - line: '$required_actions_file_version = "A.B";' +> Update the announcement at doc/webserver/announce.txt.

If the HTML documentation is not in sync with the SGML sources - you need to regenerate and upload it to the webserver. (If in - doubt, just do it.) See the Section "Updating the webserver" in - this manual for details. +> All documentation should be rebuilt: + $ make man + $ make dok + $ make dok-man + $ make dok-tidy + $ make config-file + 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. config, + 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 + "Updating the webserver" + in this manual for details.

Commit all files that were changed in the above steps! +

The User Manual 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 User Manual + link from the main page since we need to keep manuals for various + versions available). The CGI pages will link to something like + https://www.privoxy.org/$(VERSION)/user-manual/. This + needs to be updated for each new release and is done with the + "webserver" target.

Tag all files in CVS with the version number with +> Tag all files in Git with the version number with "cvs tag v_X_Y_Zgit tag -s v_X_Y_Z". Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc. @@ -272,12 +508,14 @@ CLASS="COMMAND" >

If the release was in a development branch, increase the point version - from even to odd (X.Y.(Z+1)) again in configure.in and - commit your change. +> Push the tag to the remote with + "git push origin v_X_Y_Z".

. (i.e. dot). +> (i.e. dot).

8.3. Building and Releasing the Packages6.3. Building and Releasing the Packages
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.
For For all types of packages, including the source tarball, - you must make sure that you build from clean sources by exporting - the right version from CVS into an empty directory:. + the right version from Git into an empty directory (just press return when + asked for a password):

mkdir dist # delete or choose different name if it already exists cd dist - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
-
Do NOT change a single bit, including, but not limited to - version information after export from CVS. This is to make sure that + 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.
Please find additional instructions for the source tarball and the - individual platform dependent binary packages below. -
8.3.1. Source Tarball
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -

cd current - autoheader && autoconf && ./configure
Warning
-
Then do: -

make tarball-dist
-
To upload the package to Sourceforge, simply issue -

make tarball-upload
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! +
-
Go to the displayed URL and release the file publicly on Sourceforge. - For the change log field, use the relevant section of the - ChangeLog file. -
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. +
8.3.2. SuSE or Red Hat RPM6.3.1. Note on Privoxy Packaging
In following text, replace Please keep these general guidelines in mind when putting together + your package. These apply to dist - with either "rh" for Red Hat or "suse" for SuSE. -
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). -
all platforms! +
As the only exception to not changing anything after export from CVS, - now examine the file privoxy-
Privoxy dist.specrequires - and make sure that the version information and the RPM release number are - correct. The RPM release numbers for each version start at one. Hence it must - be reset to one if this is the first RPM for - dist which is built from version - X.Y.Z. Check the - file - list if unsure. Else, it must be set to the highest already available RPM - release number for that version plus one. -
*.action files, all + logfiles, and the trust file. You will + need to determine the best way to do this for your platform. +
Then run: -
Please include up to date documentation. At a bare minimum: +

LICENSE (top-level directory) +
cd current - autoheader && autoconf && ./configure

-
Then do -

README (top-level directory) +
make dist-dist

-
To upload the package to Sourceforge, simply issue -

AUTHORS (top-level directory) +
make dist-upload rpm_packagerev

man page (top-level directory, Unix-like + platforms only) +
The User Manual (doc/webserver/user-manual/) +
FAQ (doc/webserver/faq/) +
Also suggested: Developer Manual -
ChangeLog + (top-level directory). FAQ and the manuals are + HTML docs. +
where rpm_packagerev is the - RPM release number as determined above. - Go to the displayed URL and release the file publicly on Sourceforge. - Use the release notes and change log from the source tarball package. +> The documentation has been designed such that the manuals are linked + to each other from parallel directories, and should be packaged + that way. privoxy-index.html can also be + included and can serve as a focal point for docs and other links of + interest (and possibly renamed to index.html). + 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 + doc/webserver/man-page/privoxy-man-page.html, + and should be included along with the manuals. There is also a + css stylesheets that can be included for better presentation: + p_doc.css. This should be in the same directory + with privoxy-index.html, (i.e. one level up from + the manual directories). +
user.action and user.filter + are designed for local preferences. Make sure these do not get overwritten! + config should not be overwritten either. This + has especially important configuration data in it. + trust should be left in tact as well. +
Other configuration files (default.action, + regression-tests.action and + default.filter) 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. +
Please check platform specific notes in this doc, if you haven't + done "Privoxy" 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).
Packagers should do a "clean" 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. +
8.3.3. OS/26.3.2. Source Tarball
First, First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing - packages" above). Then get the OS/2 Setup module: -

cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
autoheader && autoconf && ./configure
-
You will need a mix of development tools. - The main compilation takes place with IBM Visual Age C++. - Some ancillary work takes place with GNU tools, available from - various sources like hobbes.nmsu.edu. - Specificially, you will need autoheader, - autoconf and sh tools. - The packaging takes place with WarpIN, available from various sources, including - its home page: xworkplace. -
Change directory to the os2setup directory. - Edit the os2build.cmd file to set the final executable filename. - For example, -
Then do: +
installExeName='privoxyos2_setup_X.Y.Z.exe'
make tarball-dist
-
6.3.3. Windows
Next, edit the IJB.wis file so the release number matches - in the Note that the docbook generated files might need some hand editing, + so the Windows build makefile does not rebuild the docs. +
First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above). +
Check that you have the current versions of the + NSIS installer, + PCRE library, + MBED TLS library, + Brotli library, + and that the MAKENSIS evar in + PACKAGEID section: -
windows/GNUMakefile + points to the NSIS installer program. (See the + Building from Source / Windows + section of the User Manual for details.) +
Then you can build the package. This is fully automated, and is + controlled by windows/GNUmakefile. + All you need to do is: +
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
cd windows + make
-
You're now ready to build. Run: -
Now you can manually rename privoxy_setup.exe to + privoxy_setup_X.Y.Z.exe, and the build + directory to privoxy_X.Y.Z. + Create a .zip file of the newly renamed privoxy_X.Y.Z directory, + GPG sign the installer and zip file, +
os2build
gpg --armor --detach --sign privoxy_setup_X.Y.Z.exe + gpg --armor --detach --sign privoxy_X.Y.Z.zip
-
You will find the WarpIN-installable executable in the - ./files directory. Upload this anonymously to - uploads.sourceforge.net/incoming, create a release - for it, and you're done. Use the release notes and Change Log from the - source tarball package. -
and upload the files to SourceForge. +
When releasing the package on SourceForge, use the release notes + and Change Log from the source tarball package. +
8.3.4. Solaris6.3.4. Debian
Login to Sourceforge's compilefarm via ssh: -
Using git-buildpackage we start with a clone of the last Debian version: +
ssh cf.sourceforge.net
gbp clone https://salsa.debian.org/debian/privoxy.git + cd privoxy
-
Choose the right operating system (not the Debian one). - When logged in, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -
or if the repository is already there +
cd privoxy + gbp pull
Now import the newly released upstream tarball via debian/watch file: +
cd current - autoheader && autoconf && ./configure
gbp import-orig --uscan
-
Then run -
Next update all Debian quilt patches to the new version: +
while quilt push; do quilt refresh; done
If some patch is no longer required (because it is already merged + upstream), it can be removed using +
gmake solaris-dist
quilt delete XX_patchname.patch + git rm debian/patches/XX_patchname.patch
-
which creates a gzip'ed tar archive. Sadly, you cannot use make - solaris-upload on the Sourceforge machine (no ncftpput). You now have - to manually upload the archive to Sourceforge's ftp server and release - the file publicly. Use the release notes and Change Log from the - source tarball package. -
8.3.5. Windows
If the patch needs modification, you can apply, edit and update it with +
quilt push -f + quilt edit some_file + quilt refresh
You should ensure you have the latest version of Cygwin (from - http://www.cygwin.com/). - Run the following commands from within a Cygwin bash shell. +> until
while quilt push; do quilt refresh; done
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then get the Windows setup module: +> succeeds. Then you can
quilt pop -a
Now add a new entry to the debian/changelog representing the new + version: +
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
dch -v 3.0.34-1
-
Then you can build the package. This is fully automated, and is - controlled by winsetup/GNUmakefile. - All you need to do is: +> and describe what you did before and don't forget to git commit all + changes.
Now you can build the package on the local machine using +
cd winsetup - make
gbp buildpackage -us -uc
-
Now you can manually rename privoxy_setup.exe to - privoxy_setup_X_Y_Z.exe, and upload it to - SourceForge. When releasing the package on SourceForge, use the release notes - and Change Log from the source tarball package. +> You should check for warnings using
8.3.6. Debian
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then, run: -

cd current - autoheader && autoconf && ./configure
lintian -iI ../build-area/privoxy_3.0.34-1_amd64.changes
-
Then do FIXME. -
8.3.7. Mac OSX
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then get the Mac OSX setup module: -
Maybe rebuild the package in different defined cowbuilder environments + like +
cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
sudo cowbuilder --build --basepath /var/cache/pbuilder/base.cow ../build-area/privoxy_3.0.34-1.dsc
-
Then run: -
And try to run autopackage testing suite on the result: +
cd osxsetup - build
autopkgtest /var/cache/pbuilder/result/privoxy_3.0.34-1_amd64.changes -s -- schroot sid
-
This will run autoheader, autoconf and - configure as well as make. - Finally, it will copy over the necessary files to the ./osxsetup/files directory - for further processing by PackageMaker. -
Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package - name to match the release, and hit the "Create package" button. - If you specify ./Privoxy.pkg as the output package name, you can then create - the distributable zip file with the command: -
Or just push the changes to salsa.debian.org, where a CI pipeline is + defined for the package, that builds and tests it. +
If everything is okay, run cowbuilder with i386 and amd64 environments + for current Debian stable release and build + privoxy_3.0.34-1_i386.deb and privoxy_3.0.34-1_amd64.deb. + Then sign both files: +
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
gpg --detach-sign --armor privoxy_3.0.34-1_i386.deb + gpg --detach-sign --armor privoxy_3.0.34-1_amd64.deb
-
You can then upload privoxyosx_setup_x.y.z.zip anonymously to - uploads.sourceforge.net/incoming, - create a release for it, and you're done. Use the release notes - and Change Log from the source tarball package. -
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/ +
8.3.8. FreeBSD
6.3.4.1. Debian GIT Snapshot
Login to Sourceforge's compilefarm via ssh: -
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: +
ssh cf.sourceforge.net
sudo apt install build-essential devscripts + sudo apt-get build-dep privoxy
-
Choose the right operating system. - When logged in, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -
After this enter the checked out privoxy git tree and check that all + (new) build dependencies are met: +
cd current - autoheader && autoconf && ./configure
dpkg-checkbuilddeps
-
Then run: -
If something is missing, just add it using +
gmake freebsd-dist
sudo apt install foobar
-
which creates a gzip'ed tar archive. Sadly, you cannot use make - freebsd-upload on the Sourceforge machine (no ncftpput). You now have - to manually upload the archive to Sourceforge's ftp server and release - the file publicly. Use the release notes and Change Log from the - source tarball package. -
8.3.9. HP-UX 11
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -
Now you may update debian/changelog, especially the version number + using +
cd current - autoheader && autoconf && ./configure
dch
-
Then do FIXME. -
8.3.10. Amiga OS
First, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -
and finally build the package: +
cd current - autoheader && autoconf && ./configure
debuild -us -uc -b
-
Then do FIXME. -
8.3.11. AIX
Login to Sourceforge's compilefarm via ssh: -
If everything went okay, you may find the resulting Debian package in + the parent directory. +
You may want to clean up the build tree using +
ssh cf.sourceforge.net
debian/rules clean
-
Choose the right operating system. - When logged in, make sure that you have freshly exported the right - version into an empty directory. (See "Building and releasing - packages" above). Then run: -
And maybe repair some artefacts using one or both of the following + commands: +
cd current - autoheader && autoconf && ./configure
git reset --hard + git clean -fd
-

8.3.1. Source Tarball

8.3.2. SuSE or Red Hat RPM6.3.1. Note on Privoxy Packaging

8.3.3. OS/26.3.2. Source Tarball

6.3.3. Windows

8.3.4. Solaris6.3.4. Debian

8.3.5. Windows

8.3.6. Debian

8.3.7. Mac OSX

8.3.8. FreeBSD

8.3.9. HP-UX 11

8.3.10. Amiga OS

8.3.11. AIX

6.3.5. macOS / OS X

6.3.6. FreeBSD