1BUILDBOT(1) User Commands BUILDBOT(1)
3
7 buildbot - a tool for managing buildbot master instances
8
10 General Invocation
11 buildbot [ global options ] command [ command options ]
12 buildbot command -h|--help
14 Command Options
16 buildbot create-master [ -q|--quiet ] [ -f|--force ] [ -r|--relocatable
17 ] [ -n|--no-logrotate ] [ -s|--log-size SIZE ] [ -l|--log-count COUNT ]
18 [ -c|--config CONFIG ] [ --db DATABASE ] [ PATH ]
19 buildbot upgrade-master [ -q|--quiet ] [ -r|--replace ] [ --db DATABASE
21 ] [ PATH ]
22 buildbot [ --verbose ] { start|stop|restart|sighup|reconfig } [ PATH ]
24 buildbot sendchange [ -m|--master MASTER ] [ -u|--username USERNAME ] [
26 -R|--repository REPOSITORY ] [ -P|--project PROJECT ] [ -b|--branch
27 BRANCH ] [ -C|--category CATEGORY ] [ -r|--revision REVISION ] [
28 --revision-file REVISIONFILE ] [ -p|--property PROPERTY ] [ -c|--com‐
29 ments MESSAGE ] [ -F|--logfile LOGFILE ] [ -w|--when TIMESTAMP ]
30 FILES...
31 buildbot try [ --wait ] [ -n|--dry-run ] [ --get-builder-names ] [
33 -c|--connect {ssh|pb} ] [ --tryhost HOSTNAME ] [ --trydir PATH ] [
34 -m|--master MASTER ] [ -u|--username USERNAME ] [ --passwd PASSWORD ] [
35 --diff DIFF ] [ --patchlevel PATCHLEVEL ] [ --baserev BASEREV ] [ --vc
36 {cvs|svn|tla|baz|darcs|p4} ] [ --branch BRANCH ] [ -b|--builder BUILDER
37 ] [ --properties PROPERTIES ] [ --try-topfile FILE ] [ --try-topdir
38 PATH ]
39 buildbot tryserver [ --jobdir PATH ]
41 buildbot checkconfig [ CONFIGFILE ]
43 buildbot [ --verbose ] { start|stop|restart|sighup|reconfig } [ PATH ]
45 buildbot [ --verbose ] { --help|--version }
47
50 The `buildbot' command-line tool can be used to start or stop a build‐
51 master and to interact with a running buildmaster instance. Some of
52 its subcommands are intended for buildmaster admins, while some are for
53 developers who are editing the code that the buildbot is monitoring.
54
57 Commands
58 create-master
59 Create and populate a directory for a new buildmaster
60 upgrade-master
62 Upgrade an existing buildmaster directory for the current ver‐
63 sion
64 start Start a buildmaster
66 stop Stop a buildmaster
68 restart
70 Restart a buildmaster
71 sighup|reconfig
73 Send SIGHUP signal to buildmaster to make it re-read the config
74 file
75 sendchange
77 Send a change to the buildmaster
78 try Run a build with your local changes. This command requires in-
80 advance configuration of the buildmaster to accept such build
81 requests. Please see the documentation for details about this
82 command.
83 tryserver
85 buildmaster-side ´try´ support function, not for users
86 checkconfig
88 Validate buildbot master config file.
89 Global options
92 -h|--help
93 Print the list of available commands and global options. All
94 subsequent commands are ignored.
95 --version
97 Print Buildbot and Twisted versions. All subsequent commands
98 are ignored.
99 --verbose
101 Verbose output.
102 create-master command options
105 -q|--quiet
106 Do not emit the commands being run
107 -f|--force
109 Re-use an existing directory (will not overwrite master.cfg
110 file)
111 -r|--relocatable
113 Create a relocatable buildbot.tac
114 -n|--no-logrotate
116 Do not permit buildmaster rotate logs by itself.
117 -c|--config
119 Set name of the buildbot master config file to CONFIG. Default
120 file name is master.cfg.
121 -s|--log-size
123 Set size at which twisted lof file is rotated to SIZE bytes.
124 Default value is 1000000 bytes.
125 -l|--log-count
127 Limit the number of kept old twisted log files to COUNT. All
128 files are kept by default.
129 --db Set the database connection for storing scheduler/status state
131 to DATABASE. Default value is sqlite:///state.sqlite.
132 PATH Directory where buildbot master files will be stored.
134 upgrade-master command options
137 -q|--quiet
138 Do not emit the commands being run.
139 -r|--replace
141 Replace any modified files without confirmation.
142 --db Set the database connection for storing scheduler/status state
144 to DATABASE. Default value is sqlite:///state.sqlite.
145 PATH Directory where buildbot master files are stored.
147 sendchange command options
150 --master
151 Set the location of buildmaster's PBChangeSource to attach to in
152 form HOST:PORT.
153 -u|--username
155 Set committer's username to USERNAME.
156 -R|--repository
158 Set repository URL to REPOSITORY.
159 -P|--project
161 Set project specifier to PROJECT.
162 -b|--branch
164 Set branch name to BRANCH.
165 -c|--category
167 Set category of repository to CATEGORY.
168 -r|--revision
170 Set revision being built to REVISION.
171 --revision-file
173 Use REVISIONFILE file to read revision spec data from.
174 -p|--property
176 Set property for the change to PROPERTY. It should be in format
177 NAME:VALUE.
178 -m|--comments
180 Set log message to MESSAGE.
181 -F|--logfile
183 Set logfile to LOGFILE.
184 -w|--when
186 Set timestamp used as the change time to TIMESTAMP.
187 FILES Lis of files have been changed.
189 try command options
192 --wait Wait until the builds have finished.
193 -n|--dry-run
195 Gather info, but don't actually submit.
196 --get-builder-names
198 Get the names of available builders. Doesn't submit anything.
199 Only supported for 'pb' connections.
200 -c|--connect
202 Connection type. Can be either ´ssh´ or ´pb´.
203 --tryhost
205 Set the hostname (used by ssh) for the buildmaster to HOSTNAME.
206 --trydir
208 Specify trydir (on the tryhost) where tryjobs are deposited.
209 -m|--master
211 Set the location of the buildmaster's try scheduler in form
212 HOST:PORT
213 -u|--username
215 Set the username performing the trial build to USERNAME.
216 --passwd
218 Set password for PB authentication to PASSWORD.
219 --diff Use DIFF file to use as a patch instead of scanning a local
221 tree. Use ´-´ for stdin.
222 --patchlevel
224 Specify the patchlevel to apply with. Defaults to 0. See patch
225 for details.
226 --baserev
228 Use BASEREV revision instead of scanning a local tree.
229 --vc Specify version control system in use. Possible values: cvs,
231 svn, tla, baz, darcs, p4.
232 --branch
234 Specify the branch in use, for VC systems that can't figure it
235 out themselves.
236 -b|--builder
238 Run the trial build on the specified Builder. Can be used multi‐
239 ple times.
240 --properties
242 Specify the set of properties made available in the build envi‐
243 ronment in format prop1=value1,prop2=value2...
244 --try-topfile
246 Specify name of a file at the top of the tree. This option is
247 used to find the top. Only needed for SVN and CVS.
248 --try-topdir
250 Specify the path to the top of the working copy. Only needed
251 for SVN and CVS.
252 tryserver command options
255 --jobdir
256 The jobdir (maildir) for submitting jobs
257
259 master.cfg
260 Buildbot master configuration file
261
263 buildbot-worker(1), patch(1)
264Buildbot August 2010 BUILDBOT(1)