Mercurial > bitten > bitten-test

annotate doc/install.txt @ 420:23de253435b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Slaves now attempt to explicitly cancel builds when they are interrupted.
author cmlenz
date Wed, 08 Aug 2007 17:53:18 +0000
parents 84b8cde2dfd4
children cfbc9ee622d5
rev   line source
412
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
2
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
3 ============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
4 Installation
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
5 ============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
6
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
7 .. contents:: Contents
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
8 :depth: 2
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
9 .. sectnum::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
10
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
11
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
12 Prerequisites
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
13 =============
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
14
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
15 Bitten is written in Python, so make sure that you have Python installed.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
16 You'll need Python 2.3 or later. Also, make sure that setuptools_, version 0.6a2
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
17 or later, is installed.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
18
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
19 .. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
20
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
21 If that's taken care of, you just need to download and unpack the Bitten
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
22 distribution, and execute the command::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
23
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
24 $ python setup.py install
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
25
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
26 from the top of the directory where you unpacked (or checked out) the Bitten
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
27 code. Note that you may need administrator/root privileges for this step, as
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
28 it will by default attempt to install Bitten to the Python site-packages
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
29 directory on your system.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
30
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
31 It's also a good idea to run the unit tests at this point, to make sure that
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
32 the code works as expected on your platform::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
33
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
34 $ python setup.py test
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
35
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
36
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
37 What's left to do now depends on whether you want to use the build master and
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
38 web interface, or just the build slave. In the latter case, you're already
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
39 done. You might need to install software that the build of your project
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
40 requires, but the Bitten build slave itself doesn't require anything extra.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
41
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
42 For the build master and web interface, you'll need to install Trac 0.10 or
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
43 later. Please refer to the Trac documentation for information on how it is
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
44 installed.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
45
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
46
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
47 Build Master Configuration
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
48 ==========================
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
49
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
50 Once both Bitten and Trac are installed and working, you'll have to introduce
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
51 Bitten to your Trac project environment. If you don't have a Trac project
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
52 set up yet, you'll need to do so in order to use Bitten.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
53
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
54 If you already have a Trac project environment, the Bitten plugin needs to be
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
55 explicitly enabled in the Trac configuration. This is done by adding it to the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
56 [components] section in /path/to/projenv/conf/trac.ini:
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
57
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
58 .. code-block:: ini
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
59
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
60 [components]
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
61 bitten.* = enabled
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
62
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
63 The Trac web interface should now inform you with an error message that the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
64 environment needs to be upgraded. To do this, run::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
65
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
66 $ trac-admin /path/to/projenv upgrade
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
67
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
68 This will create the database tables and directories that Bitten requires.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
69 You probably also want to grant permissions to someone (such as yourself)
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
70 to manage build configurations, and allow anonymous users to view the
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
71 status and results of builds::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
72
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
73 $ trac-admin /path/to/projenv permission add anonymous BUILD_EXEC
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
74 $ trac-admin /path/to/projenv permission add anonymous BUILD_VIEW
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
75 $ trac-admin /path/to/projenv permission add [yourname] BUILD_ADMIN
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
76
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
77 You should now see an additional tab labeled "Build Status" in the Trac
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
78 navigation bar. This link will take you to the list of build configurations,
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
79 which at this point is of course empty. If you've set up permissions
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
80 correctly as described previously, you should see a button for adding new
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
81 build configurations. Click that button and fill out the form. Also, add
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
82 at least one target platform after saving the configuration. Last but not
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
83 least, you'll have to "activate" the build configuration.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
84
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
85
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
86 Running the Build Slave
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
87 =======================
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
88
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
89 The build slave can be run on any machine that can connect to the machine
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
90 on which the build master is running. The installation of Bitten should have put
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
91 a `bitten-slave` executable on your path. If the script is not on your path,
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
92 look for it in the `bin` or `scripts` subdirectory of your Python installation.
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
93
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
94 To get a list of options for the build slave, execute it with the `--help`
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
95 option::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
96
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
97 $ bitten-slave --help
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
98
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
99 To run the build slave against a Bitten-enabled Trac site installed at
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
100 http://myproject.example.org/trac, you'd run::
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
101
84b8cde2dfd4 Start with documentation.
cmlenz
parents:
diff changeset
102 $ bitten-slave http://myproject.example.org/trac/builds
Copyright (C) 2012-2017 Edgewall Software