X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fdeveloper-manual%2Fnewrelease.html;h=62721d34ccb6073a8e120a382fc24a978b0c6063;hp=9e364c901f9cd2c680d7d722e3126d576cb79732;hb=0212c18282eaa5f73843cbbec12c9137ea596e1c;hpb=86ac3ff98d6515df64db2e147c1725cf87dabda5 diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index 9e364c90..62721d34 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -1,10 +1,11 @@ Releasing a new versionReleasing a New VersionNext8. Releasing a new version6. Releasing a New Version

To minimize trouble with distribution contents, webpage - errors and the like, we strongly encourage you - to follow this section if you prepare a new release of - code or new pages on the webserver. +> When we release versions of Privoxy, + 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. +

So when releasing a new version, please adhere exactly to the + procedure outlined in this chapter.

The following programs are required to follow this process: @@ -85,23 +95,89 @@ CLASS="FILENAME" >ncftpput (ncftp), scpscp, ssh (ssh), -gmake (GNU's version of make), autoconf, cvs, ???. +> (GNU's version of make), autoconf, cvs.

6.1. Version numbers

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: +

8.1. Before the Release6.2. Before the Release: Freeze

The following "no!" in case - they have pending changes/fixes in their pipelines. + they have pending changes/fixes in their pipelines. Announce the + freeze so that nobody will interfere with last minute changes.

  • Increment the version number in configure.in in - CVS. Also, inrease or reset the RPM release number in - configure.in as appropriate. Do NOT - touch version information after export from CVS. - All packages will use the version and release data - from Increment the version number (point from odd to even in development + branches!) in configure.in. - Local files should not be changed, except prior to a CVS commit!!! - This way we are all on the same page!

  • If the default actionsfile has changed since last release, - bump up its version info in this line: +> If 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:

    @@ -166,8 +229,7 @@ WIDTH="90%" >

      {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
-
    {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}

  • 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. +

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

  • 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).

    • 8.2. Update the webserver6.3. Building and Releasing the Packages

    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. +

    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:. + 

      make webserver
-
    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
    -

    Note that "make dok" - (or "make redhat-dok") creates - doc/webserver/user-manual, - doc/webserver/developer-manual, - doc/webserver/faq and - doc/webserver/man-page automatically. -

    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. +

    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. -

    Please find additional instructions for the source tarball and the + individual platform dependent binary packages below. +

    8.3. SuSE or Red Hat

    6.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
    +

    Then do: + 

      make tarball-dist
    +

    Ensure that you have the latest code version. Hence run: +> To upload the package to Sourceforge, simply issue 

      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 current
-
    make tarball-upload

    first. +> 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. +

    6.3.2. SuSE or Red Hat RPM

    In following text, replace 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). +

    As the only exception to not changing anything after export from CVS, + now examine the file privoxy-dist.spec + 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. +

    Then run: 

      autoheader && autoconf && ./configure
-
    cd current + autoheader && autoconf && ./configure

      make suse-dist or make redhat-dist
-
    make dist-dist
      make suse-upload or make redhat-upload
-
    make dist-upload rpm_packagerev

    Go to the displayed URL and release the file publicly on Sourceforge. +> 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.

    8.4. OS/2

    6.3.3. OS/2

    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: 

      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
-
    cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
    directory. Edit the os2build.cmd file to set the final executable filename. For example, - 

      installExeName='privoxyos2_setup_X.Y.Z.exe'
-
    installExeName='privoxyos2_setup_X.Y.Z.exe'
    - Next, edit the

    Next, edit the IJB.wis file so the release number matches @@ -481,7 +671,9 @@ CLASS="FILENAME" CLASS="FILENAME" >PACKAGEID section: - 

      PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
-
    PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
    - You're now ready to build. Run: -

    You're now ready to build. Run: + 

      os2build
-
    os2build
    - And in the

    You will find the WarpIN-installable executable in the + ./files directory you will have the - WarpIN-installable executable. - Upload this anonymously to - directory. Upload this anonymously to + uploads.sourceforge.net/incoming, create a release - for it, and you're done. + for it, and you're done. Use the release notes and Change Log from the + source tarball package.

    8.5. Solaris

    Login to Sourceforge's compilefarm via ssh - 

      ssh cf.sourceforge.net
-
    -

    6.3.4. Solaris

    Choose the right operating system (not the Debian one). If you have - downloaded Privoxy before, +> Login to Sourceforge's compilefarm via ssh: 

      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 current
-
    ssh cf.sourceforge.net

    If not, please checkout - Privoxy via CVS first. Run: +> 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: 

      autoheader && autoconf && ./configure
-
    cd current + autoheader && autoconf && ./configure

      gmake solaris-dist
-
    gmake solaris-dist on the Sourceforge machine (no ncftpput). You now have to manually upload the archive to Sourceforge's ftp server and release - the file publicly. + the file publicly. Use the release notes and Change Log from the + source tarball package.

    8.6. Windows

    6.3.5. Windows

    Ensure that you have the latest code version. Hence run -

    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. +

    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: + 

      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 current
-
    cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
    -

    Run: -

    Then you can build the package. This is fully automated, and is + controlled by winsetup/GNUmakefile. + All you need to do is: + 

      autoheader && autoconf && ./configure
-
    cd winsetup + make
    -

    Then do FIXME. -

    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. +

    8.7. Debian

    Ensure that you have the latest code version. Hence run: -

    6.3.6. Debian

      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 current
-
    -

    first. Run: +> 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

    8.8. Mac OSX

    6.3.7. Mac OSX

    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 OSX setup module: 

      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
-
    cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup

    From the osxsetup directory, run: - Then run: + 

      build
-
    cd osxsetup + build

    zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-
    zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
    - You can then upload

    You can then upload privoxyosx_setup_x.y.z.zip anonymously to @@ -827,39 +1013,18 @@ CLASS="FILENAME" CLASS="FILENAME" >uploads.sourceforge.net/incoming, - create a release for it, and you're done. + create a release for it, and you're done. Use the release notes + and Change Log from the source tarball package.

    8.9. FreeBSD

    Change the version number of Privoxy in the - configure.in file. Run: - 
      autoheader && autoconf && ./configure
-
    - Then ... -

    6.3.8. FreeBSD

    Login to Sourceforge's compilefarm via ssh: 

      ssh cf.sourceforge.net
-
    ssh cf.sourceforge.net

    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: 

      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 current
-
    -

    Run: - 

      autoheader && autoconf && ./configure
-
    cd current + autoheader && autoconf && ./configure

      gmake freebsd-dist
-
    gmake freebsd-dist on the Sourceforge machine (no ncftpput). You now have to manually upload the archive to Sourceforge's ftp server and release - the file publicly. + the file publicly. Use the release notes and Change Log from the + source tarball package.

    8.10. Tarball

    6.3.9. HP-UX 11

    Ensure that you have the right 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: 

      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 current
-
    cd current + autoheader && autoconf && ./configure

    first. Run: - 

      autoheader && autoconf && ./configure
-
    +> Then do FIXME.

    6.3.10. Amiga OS

    Then do: +> First, make sure that you have freshly exported the right + version into an empty directory. (See "Building and releasing + packages" above). Then run: 

      make tarball-dist
-
    cd current + autoheader && autoconf && ./configure

    To upload the package to Sourceforge, simply issue - 

      make tarball-upload
-
    +> Then do FIXME.

    Goto the displayed URL and release the file publicly on Sourceforge. -

    8.11. HP-UX 11

    Ensure that you have the latest code version. Hence run: - 

      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 current
-
    -

    6.3.11. AIX

    first. Run: +> Login to Sourceforge's compilefarm via ssh: 

      autoheader && autoconf && ./configure
-
    ssh cf.sourceforge.net

    Then do FIXME. -

    8.12. Amiga OS

    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: 

      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 current
-
    cd current + autoheader && autoconf && ./configure

    first. Run: +> Then run: 

      autoheader && autoconf && ./configure
-
    make aix-dist

    Then do FIXME. +> which creates a gzip'ed tar archive. Sadly, you cannot use make + aix-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.13. AIX6.4. Uploading and Releasing Your Package

    Login to Sourceforge's compilefarm via ssh: -

    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: + 

      ssh cf.sourceforge.net
-

    • Upload to: ftp://upload.sourceforge.net/incoming -

    • Choose the right operating system. If you have downloaded Privoxy - before: -

      user: anonymous + 

    •   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 current
-
      password: ijbswa-developers@lists.sourceforge.net -

    +

    If not, please Once this done go to checkout - Privoxy via CVS first. Run: -

    http://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. 2.9.15 + (beta). + 

      autoheader && autoconf && ./configure
-
    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" -

    Then run: -

    "email" box at the very bottom to notify them of + the new package. This should do it! + 

      make aix-dist
-
    -

    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. +

    6.5. After the Release

    which creates a gzip'ed tar archive. Sadly, you cannot use make - aix-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. -

    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 change log. +

    NextContacting the developers, Bug Reporting and Feature RequestsUpdate the Webserver