X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fnewrelease.html;h=6814b0eabbda4cd386f8c5d57dbfdccebe98c1b2;hb=1e5dbf87271fb9afca4ccd18a19c42e6d4d80dea;hp=9e67a867db57113ca90b6e6dadcdb893e2f842c9;hpb=281c503f6d2799387e2dfac7fccdd3d885c6312e;p=privoxy.git diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index 9e67a867..6814b0ea 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -1,11 +1,11 @@ +
Next | 8. Releasing a new version6. Releasing a New Version{+add-header{X-Actions-File-Version: A.B} -filter -no-popups} -{+add-header{X-Actions-File-Version: A.B} -filter -no-popups} |
All documentation should be rebuild after the version bump. + Finished docs should be then be committed to CVS (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), and the PDF docs + fall in this category. REAMDE, the man page, AUTHORS, and config + should all also be committed to CVS for other packagers. The + formal docs should be uploaded to the webserver. See the + Section "Updating the webserver" in this manual for details. +
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 + http://privoxy.org/$(VERSION)/user-manual/. This + will need to be updated for each new release. There is no Makefile + target for this at this time!!! It needs to be done manually. +
All developers should look at the ChangeLog and + make sure noteworthy changes are referenced. +
Commit all files that were changed in the above steps! +
Tag all files in CVS with the version number with cvs tag v_X_Y_Z" (where X = major, Y - = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) - etc. +>. + Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
The first package uploaded should be the official - "tarball" release. This is built with the - "make tarball-dist" Makefile - target, and then can be uploaded with - "make tarball-upload" (see below). +> 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. +
On the webserver, copy the user manual to a new top-level directory + called X.Y.Z. 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 X.Y.(Z-1) + to X.Y.Z and X.Y.(Z+1) to + . (i.e. dot).
All files must be group-readable and group-writable (or no one else - will be able to change them). To update the webserver, create any - pages locally in the doc/webserver directory (or - create new directories under doc/webserver), then do -
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. +
make webserver -mkdir dist # delete or choose different name if it already exists + cd dist + cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current |
Note that "make dok" - (or "make redhat-dok") creates - Do NOT change a single bit, including, but not limited to + version information after export from CVS. This is to make sure that + all release packages, and with them, all future bug reports, are based + on exactly the same code. +
Warning |
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! + |
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. +
Please keep these general guidelines in mind when putting together + your package. These apply to all platforms! +
Privoxy requires + write access to: all doc/webserver/user-manual, - *.action files, all + logfiles, and the doc/webserver/developer-manual, - trust file. You will + need to determine the best way to do this for your platform. +
Please include up to date documentation. At a bare minimum: +
doc/webserver/faq and - LICENSE (top-level directory) + |
doc/webserver/man-page automatically. - README (top-level directory) + |
Please do NOT use any other means of transferring files to the - webserver. "make webserver" not only - uploads, but will make sure that the appropriate permissions are - preserved for shared group access. -
Ensure that you have the latest code version. Hence run: -
AUTHORS (top-level directory) + |
cd current - 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 - | man page (top-level directory, Unix-like
+ platforms only)
+
The User Manual (doc/webserver/user-manual/) + |
FAQ (doc/webserver/faq/) + |
Also suggested: Developer Manual + (doc/webserver/developer-manual) and ChangeLog + (top-level directory). FAQ and the manuals are + HTML docs. There are also text versions in + doc/text/ which could conceivably also be + included. +
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 CVS 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 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. +
first. +> First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above). Then run:
autoheader && autoconf && ./configure -cd current + autoheader && autoconf && ./configure |
Then do +> Then do:
make suse-dist or make redhat-dist -make tarball-dist |
make suse-upload or make redhat-upload -make tarball-upload
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.
Ensure that you have the latest code version. Hence run: -
cd current - 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 - cd .. - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup - |
In following text, replace dist -
"rh" for Red Hat or "suse" for SuSE. +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. +> First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above).
Change directory to the os2setup directory. - Edit the os2build.cmd file to set the final executable filename. - For example, -
installExeName='privoxyos2_setup_X.Y.Z.exe' - |
PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z" - |
os2build - |
Login to Sourceforge's compilefarm via ssh -
ssh cf.sourceforge.net - |
Choose the right operating system (not the Debian one). If you have - downloaded Privoxy before, +> Then run:
If not, please checkout - Privoxy via CVS first. Run: +> Then do
autoheader && autoconf && ./configure -make dist-dist |
Then run +> To upload the package to Sourceforge, simply issue
gmake solaris-dist -make dist-upload rpm_packagerev |
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. -
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. +Ensure that you have the latest code version. Hence run +> 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:
cd current - 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 -cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup |
Run: +> 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,
autoheader && autoconf && ./configure -installExeName='privoxyos2_setup_X.Y.Z.exe' |
Then do FIXME. -
Ensure that you have the latest code version. Hence run: -
Next, edit the IJB.wis file so the release number matches + in the PACKAGEID section: +
cd current - 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 -PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z" |
first. Run: +> You're now ready to build. Run:
autoheader && autoconf && ./configure -os2build |
Then do FIXME. +> 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.
Ensure that you have the latest code version. Hence run: +> Login to Sourceforge's compilefarm via ssh:
cd current - 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 - cd .. - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup -ssh cf.sourceforge.net |
From the osxsetup directory, run: -
build - |
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. +> cd current + autoheader && autoconf && ./configure
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: -
zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg -gmake solaris-dist |
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.
Change the version number of Privoxy in the - configure.in file. Run: -
autoheader && autoconf && ./configure -cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup |
Login to Sourceforge's compilefarm via ssh: -
Then you can build the package. This is fully automated, and is + controlled by winsetup/GNUmakefile. + All you need to do is: +
ssh cf.sourceforge.net -cd winsetup + make |
Choose the right operating system. If you have downloaded Privoxy - before, -
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. +
cd current - 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 -debchange -v 3.0.11-stable-1 "New upstream version" |
If not, please checkout - Privoxy via CVS first. Run: -
Then, run: +
autoheader && autoconf && ./configure -dpkg-buildpackage -rfakeroot -us -uc -b |
Then run: -
This will create + ../privoxy_3.0.11-stable-1_i386.deb + which can be uploaded. To upload the package to Sourceforge, simply + issue +
gmake freebsd-dist -make debian-upload |
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. -
Ensure that you have the latest code version. Hence run: +> 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 OS X setup module:
cd current - 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 -cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup |
first. Run: +> Then run:
make clobber - autoheader && autoconf && ./configure -cd osxsetup + build |
Then do: +> 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:
make tarball-dist -zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg |
To upload the package to Sourceforge, simply issue +> 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. +
Login to Sourceforge's compile-farm via ssh:
make tarball-upload -ssh cf.sourceforge.net |
Goto the displayed URL and release the file publicly on Sourceforge. -
Ensure that you have the latest code version. Hence run: +> 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:
first. Run: +> Then run:
autoheader && autoconf && ./configure -gmake freebsd-dist |
Then do FIXME. +> 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.
Ensure that you have the latest code version. Hence run: +> First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above). Then run:
first. Run: +> Then do FIXME. +
First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above). Then run:
autoheader && autoconf && ./configure -cd current + autoheader && autoconf && ./configure |
Login to Sourceforge's compilefarm via ssh:
ssh cf.sourceforge.net -ssh cf.sourceforge.net
Choose the right operating system. If you have downloaded Privoxy - before: +> 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:
If not, please checkout - Privoxy via CVS first. Run: -
autoheader && autoconf && ./configure - |
make aix-dist -make aix-dist
After the package is ready, it is time to upload it + to SourceForge, and go through the release steps. The upload + is done via FTP: +
Upload to: ftp://upload.sourceforge.net/incoming +
user: anonymous +
password: ijbswa-developers@lists.sourceforge.net +
Or use the make targets as described above. +
Once this done go to https://sourceforge.net/project/admin/editpackages.php?group_id=11118, + making sure you are logged in. Find your target platform in the + second column, and click Add Release. You will + then need to create a new release for your package, using the format + of $VERSION ($CODE_STATUS), e.g. 3.0.11 + (beta). +
Now just follow the prompts. Be sure to add any appropriate Release + notes. You should see your freshly uploaded packages in + "Step 2. Add Files To This Release". Check the + appropriate box(es). Remember at each step to hit the + "Refresh/Submit" 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 "Update" + for each file. If anyone is monitoring your platform, check the + "email" box at the very bottom to notify them of + the new package. This should do it! +
If you have made errors, or need to make changes, you can go through + essentially the same steps, but select Edit Release, + instead of Add Release. +
When all (or: most of the) packages have been uploaded and made available, + send an email to the announce + mailing list, Subject: "Version X.Y.Z available for download". Be sure to + include the + download + location, 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. +