# HG changeset patch # User cmlenz # Date 1136896919 0 # Node ID 6a7b7b1cdbea1ae606bd44435167c11ee3b43bc1 # Parent 9644b07b90c65751b3db0ea1e6c2df0c137d0847 Update `README` and `ChangeLog`. diff --git a/ChangeLog b/ChangeLog --- a/ChangeLog +++ b/ChangeLog @@ -3,6 +3,8 @@ http://bitten.cmlenz.net/repos/bitten/tags/0.5.1 * Fixes compatibility with Trac 0.9.3 release, as well as the current trunk. + This also means that Bitten now longer works with versions of Trac earlier + than 0.9.3. * Improves PostgreSQL compatibility. * Fixes encoding of non-ASCII characters in command output. * Fix for missing log output when using on Windows. diff --git a/README.txt b/README.txt --- a/README.txt +++ b/README.txt @@ -7,20 +7,21 @@ the progress of a software project. The Bitten software consists of three separate parts: - * The build slave, which executes build on behalf of a local or remote + * The build slave, which executes builds on behalf of a local or remote build master - * The build master, which orchestrate builds for a project across all + * The build master, which orchestrates builds for a project across all connected slaves, and stores the build status and results to the database * The web interface, which is implemented as an add-on to Trac (http://trac.edgewall.com/) and provides a build management interface as well as presentation of build results. -Both the build master and the web interface depend on Trac 0.9 beta 1, and -need to be installed on the same machine, together with the Subversion -repository. The build slave only requires Python (>= 2.3) as well as the -tools required by the build process itself. A build slave may be run on -any machine that can connect to the server running the Bitten build master. +Both the build master and the web interface depend on Trac 0.9, and need +to be installed on the same machine, together with the Subversion +repository. The build slave only requires Python (>= 2.3), setuptools +(>= 0.6a2), as well as any tools required by the build process itself. A +build slave may be run on any machine that can connect to the server +running the Bitten build master. Installation @@ -38,8 +39,8 @@ from the top of the directory where you unpacked (or checked out) the Bitten code. Note that you may need administrator/root privileges for this step, as -it will attempt to install Bitten to the Python site-packages directory on -your system. +it will by default attempt to install Bitten to the Python site-packages +directory on your system. It's also a good idea to run the unit tests at this point, to make sure that the code works as expected on your platform: @@ -52,8 +53,8 @@ done. You might need to install software that the build of your project requires, but the Bitten build slave itself doesn't require anything extra. -For the build master and web interface, you'll need to install Trac 0.9 -beta 2. Please refer to the Trac documentation for information on how it is +For the build master and web interface, you'll need to install Trac 0.9.3 or +later. Please refer to the Trac documentation for information on how it is installed. @@ -64,9 +65,15 @@ Bitten to your Trac project environment. If you don't have a Trac project set up yet, you'll need to do so in order to use Bitten. -If you already have a Trac project environment, the Trac web interface -will inform you with an error message that the environment needs to be -upgraded. To do this, run: +If you already have a Trac project environment, the Bitten plugin needs to be +explicitly enabled in the Trac configuration. This is done by adding it to the +[components] section in /path/to/projenv/conf/trac.ini: + + [components] + bitten.* = enabled + +The Trac web interface should now inform you with an error message that the +environment needs to be upgraded. To do this, run: $ trac-admin /path/to/projenv upgrade @@ -78,7 +85,7 @@ $ trac-admin /path/to/projenv permission add anonymous BUILD_VIEW $ trac-admin /path/to/projenv permission add [yourname] BUILD_ADMIN -You should now see an additional tab labelled "Build Status" in the Trac +You should now see an additional tab labeled "Build Status" in the Trac navigation bar. This link will take you to the list of build configurations, which at this point is of course empty. If you've set up permissions correctly as described previously, you should see a button for adding new diff --git a/setup.cfg b/setup.cfg --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,3 @@ -[egg_info] -tag_build = dev -tag_svn_revision = true - [sdist] formats = bztar, gztar, zip