Mercurial > bitten > bitten-test
annotate README.txt @ 674:80d4c32c8103
0.6dev: Follow-up to #441 / [745]. Of course, cmd.exe built-ins was the reason for executing through shell on Windows... This fix adds back support for important built-ins by essentially calling `cmd.exe /C command + args`.
author | osimons |
---|---|
date | Mon, 07 Sep 2009 08:56:32 +0000 |
parents | cc1fefd5d814 |
children | 6511c192a957 |
rev | line source |
---|---|
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
1 About Bitten |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
2 ============ |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
3 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
4 Bitten is a simple distributed continuous integration system that not only |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
5 coordinates builds across multiple machines, but also collects software |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
6 metrics generated by builds, to enable feedback and reporting about |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
7 the progress of a software project. |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
8 |
652
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
9 The Bitten software consists of two separate parts: |
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
10 * The build slave, which executes builds on behalf of a build master. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
11 * The web interface, which is implemented as an add-on to Trac |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
12 (http://trac.edgewall.com/) and provides a build management interface |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
13 as well as presentation of build results. |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
14 |
652
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
15 The build master is a plugin for Trac 0.11, while the build slave can be |
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
16 installed without other dependencies than Python >= 2.4 and |
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
17 setuptools >= 0.6a2 in addition to any tools required by the build process |
de04ce69da53
0.6dev: Removing code and updated docs related to Trac < 0.11 and Python < 2.4 (base requirements for Bitten 0.6).
osimons
parents:
651
diff
changeset
|
18 itself. A build slave may be run on any machine that can connect to the server |
319 | 19 running the Bitten build master. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
20 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
21 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
22 Installation |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
23 ------------ |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
24 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
25 Bitten is written in Python, so make sure that you have Python installed. |
654
cc1fefd5d814
0.6dev: Moved a constant declaration so that master should still work with Python 2.4. Updated docs with regards to Python requirements + added a changelog message from cmlenz.
osimons
parents:
652
diff
changeset
|
26 You'll need Python 2.4 or later for running build slave, while the Trac plugin |
cc1fefd5d814
0.6dev: Moved a constant declaration so that master should still work with Python 2.4. Updated docs with regards to Python requirements + added a changelog message from cmlenz.
osimons
parents:
652
diff
changeset
|
27 (master) should still work using Python 2.3. Also, make sure that setuptools |
207
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
28 (http://peak.telecommunity.com/DevCenter/setuptools), version 0.6a2 or later, |
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
29 is installed. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
30 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
31 If that's taken care of, you just need to download and unpack the Bitten |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
32 distribution, and execute the command: |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
33 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
34 $ python setup.py install |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
35 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
36 from the top of the directory where you unpacked (or checked out) the Bitten |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
37 code. Note that you may need administrator/root privileges for this step, as |
319 | 38 it will by default attempt to install Bitten to the Python site-packages |
39 directory on your system. | |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
40 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
41 It's also a good idea to run the unit tests at this point, to make sure that |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
42 the code works as expected on your platform: |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
43 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
44 $ python setup.py test |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
45 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
46 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
47 What's left to do now depends on whether you want to use the build master and |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
48 web interface, or just the build slave. In the latter case, you're already |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
49 done. You might need to install software that the build of your project |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
50 requires, but the Bitten build slave itself doesn't require anything extra. |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
51 |
651
44a862c1e559
0.6dev: First round of changes to docs in preparation for 0.6 release.
osimons
parents:
582
diff
changeset
|
52 For the build master and web interface, you'll need to install Trac 0.11 or |
330
f116a5068e4e
Update README to reflect that Trac 0.9.3 is now required.
cmlenz
parents:
319
diff
changeset
|
53 later. Please refer to the Trac documentation for information on how it is |
f116a5068e4e
Update README to reflect that Trac 0.9.3 is now required.
cmlenz
parents:
319
diff
changeset
|
54 installed. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
55 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
56 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
57 Build Master Configuration |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
58 -------------------------- |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
59 |
207
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
60 Once both Bitten and Trac are installed and working, you'll have to introduce |
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
61 Bitten to your Trac project environment. If you don't have a Trac project |
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
62 set up yet, you'll need to do so in order to use Bitten. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
63 |
319 | 64 If you already have a Trac project environment, the Bitten plugin needs to be |
65 explicitly enabled in the Trac configuration. This is done by adding it to the | |
66 [components] section in /path/to/projenv/conf/trac.ini: | |
67 | |
68 [components] | |
69 bitten.* = enabled | |
70 | |
71 The Trac web interface should now inform you with an error message that the | |
72 environment needs to be upgraded. To do this, run: | |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
73 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
74 $ trac-admin /path/to/projenv upgrade |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
75 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
76 This will create the database tables and directories that Bitten requires. |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
77 You probably also want to grant permissions to someone (such as yourself) |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
78 to manage build configurations, and allow anonymous users to view the |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
79 status and results of builds: |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
80 |
393 | 81 $ trac-admin /path/to/projenv permission add anonymous BUILD_EXEC |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
82 $ trac-admin /path/to/projenv permission add anonymous BUILD_VIEW |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
83 $ trac-admin /path/to/projenv permission add [yourname] BUILD_ADMIN |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
84 |
319 | 85 You should now see an additional tab labeled "Build Status" in the Trac |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
86 navigation bar. This link will take you to the list of build configurations, |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
87 which at this point is of course empty. If you've set up permissions |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
88 correctly as described previously, you should see a button for adding new |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
89 build configurations. Click that button and fill out the form. Also, add |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
90 at least one target platform after saving the configuration. Last but not |
190 | 91 least, you'll have to "activate" the build configuration. |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
92 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
93 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
94 Running the Build Slave |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
95 ----------------------- |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
96 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
97 The build slave can be run on any machine that can connect to the machine |
393 | 98 on which the build master is running. The installation of Bitten should have put |
99 a `bitten-slave` executable on your path. If the script is not on your path, | |
100 look for it in the `bin` or `scripts` subdirectory of your Python installation. | |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
101 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
102 To get a list of options for the build slave, execute it with the `--help` |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
103 option: |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
104 |
207
0a7d06e3f0fd
Remove the wrapper scripts (now taken care of by setuptools/easy_install) and update the docs to reflect the name change.
cmlenz
parents:
190
diff
changeset
|
105 $ bitten-slave --help |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
106 |
393 | 107 To run the build slave against a Bitten-enabled Trac site installed at |
108 http://myproject.example.org/trac, you'd run: | |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
109 |
393 | 110 $ bitten-slave http://myproject.example.org/trac/builds |
189
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
111 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
112 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
113 More Information |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
114 ---------------- |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
115 |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
116 For further documentation, please see the Bitten website at: |
2f0b36b313cc
Added [source:trunk/README.txt README.txt] to explain installation, configuration and usage of Bitten. Closes #36.
cmlenz
parents:
diff
changeset
|
117 |
582
7f181708d048
0.6dev: Changing some left-over references to old project site. Closes #272.
osimons
parents:
393
diff
changeset
|
118 <http://bitten.edgewall.org/> |