Add wiki as a submodule
[buildfarm-client.git] / build-farm.conf.template
1
2 # -*-perl-*- hey - emacs - this is a perl file
3
4 =comment
5
6 Copyright (c) 2003-2010, Andrew Dunstan
7
8 See accompanying License file for license details
9
10 =cut 
11
12 package EximBuild;
13
14 use strict;
15
16 use vars qw(%conf);
17
18 # use vars qw($VERSION); $VERSION = 'REL_0.1';
19
20 my $branch;
21 {
22     no warnings qw(once);
23     $branch = $main::branch;
24 }
25
26 # This template assumes that the user running the buildfarm process is "farm"
27 my $farm_user_name = 'farm';
28
29 %conf =(
30     scm => 'git',
31     # default is github mirror of Exim
32     scmrepo => 'https://github.com/Exim/exim.git',
33     # webref for diffs on server - use default for community
34     scm_url => undef,
35     # for --reference on git repo
36     # git_reference => undef,
37     # or gmake if required. can include path if necessary.
38     make => 'make',
39     # 1 = any make will do, 0 = require GNU (default)
40     non_gnu_make => 0,
41     # >1 for parallel "make" and "make check" steps
42     make_jobs => undef,
43     # default is "tar -z -cf runlogs.tgz *.log"
44     # replacement must have the same effect
45     # must be absolute, can be either Unix or Windows style for MSVC
46     tar_log_cmd => undef,
47     # If running multiple animals, an explicit common directory for
48     # the lockfile so that runs do not conflict. Otherwise, leave unset.
49     global_lock_dir => "/home/$farm_user_name",
50     # this directory must exist before anything will work
51     build_root => "/home/$farm_user_name/buildfarm",
52     # set true to do vpath builds
53     use_vpath => undef,
54
55     keep_error_builds => 0,
56     # Linux style, use "*.core" for BSD
57     core_file_glob => "core*",
58
59     # build process will connect to this URL to upload results
60     target => "http://eximbuild.mrball.net/cgi-bin/eximstatus.pl",
61     # update_personality uses this when you want to update your
62     # machine's info (OS, version, compiler, version)
63     upgrade_target => "http://eximbuild.mrball.net/cgi-bin/upgrade.pl",
64
65     # Your host alias and password in the BuildFarm
66     animal => "alias_assigned_by_build_team",
67     secret => "secret_assigned_by_build_team",
68
69     # if force_every is a scalar it will be used on all branches, like this
70     # for legacy reasons:
71     # force_every => 336 , # max hours between builds, undef or 0 = unforced
72     # we now prefer it to be a hash with branch names as the keys, like this
73     #
74     # this setting should be kept conservatively high, or not used at all  -
75     # for the most part it's best to let the script decide if something
76     # has changed that requires a new run for the branch.
77     #
78     # an entry with a name of 'default' matches any branch not named
79     force_every => {
80         HEAD => 24*7,
81         # default => 168,
82     },
83
84     # alerts are triggered if the server doesn't see a build on a branch after
85     # this many hours, and then sent out every so often,
86     alerts => {
87         #HEAD          => { alert_after => 72,  alert_every => 24 },
88     },
89
90     print_success => undef,
91
92     # include / exclude pattern for files whose trigger a build
93     # if both are specified then they are both applied as filters
94     # undef means don't ignore anything.
95     # exclude qr[/(doc|po)/] to ignore changes to docs and po files (recommended)
96     # undef means null filter.
97     trigger_exclude => qr[/(doc|po)/],
98     trigger_include => undef,
99
100     # settings for mail notices - default to notifying nobody
101     # these lists contain addresses to be notified
102     # must be complete email addresses, as the email is sent from the server
103     mail_events =>{
104         all => [], # unconditional
105         fail => [], # if this build fails
106         change => [], # if this build causes a state change
107         green => [], # if this build causes a state change to/from OK
108     },
109
110     # env settings to apply within build/report process
111     # these settings will be seen by all the processes, including the
112     # configure process.
113     build_env =>{
114         # use a dedicated cache for the build farm. this should give us
115         # very high hit rates and slightly faster cache searching.
116         CCACHE_DIR => "/home/$farm_user_name/buildfarm/ccache/$branch",
117
118         ### set this if you need a proxy setting for the
119         # outbound web transaction that reports the results
120         # BF_PROXY => 'http://my.proxy.server:portnum/',
121     },
122
123     # Environment settings on the make commandline.
124     # These cause full compile output and don't strip the binary.
125     make_args => q/FULLECHO='' STRIP_COMMAND=''/,
126
127     # Settings to add to Local/Makefile. These will set or override
128     # previous definitions of variables.  Example:
129     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
130     makefile_set =>{
131         # comment out if not using ccache
132         CC => 'ccache gcc',
133         # Required for some tests to pass
134         AUTH_PLAINTEXT => 'yes',
135         SUPPORT_MAILDIR => 'yes',
136         # Other examples. Could use makefile_regex instead.
137         #SUPPORT_TLS => 'yes',
138         #USE_OPENSSL_PC => 'openssl',
139         #TLS_LIBS => '-lssl -lcrypto',
140         #EXPERIMENTAL_SPF => 'yes',
141         #LOOKUP_LDAP => 'yes',
142         #LOOKUP_INCLUDE => '-I/usr/include/mysql',
143         #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
144         #LDAP_LIB_TYPE => 'OPENLDAP2',
145     },
146     # Settings to add to Local/Makefile. These will add to variables that
147     # are already defined earlier in the Makefile.  Example:
148     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
149     makefile_add =>{
150         # Show all warnings and errors
151         CFLAGS => '-Wall -Werror=format-security',
152         # Or enable debugging flags
153         #CFLAGS => '-g -Wall',
154         #LFLAGS => '-g',
155         # If set EXPERIMENTAL_SPF above, add it to the linker:
156         #LDFLAGS => '-lspf2',
157     },
158
159     # Another way to enable things in the Local/Makefile.
160     # Use a simple regex to change a default to what you want.
161     makefile_regex =>[
162         # If have perl devel libraries installed, can build embedded perl
163         #q(s/^# EXIM_PERL=/EXIM_PERL=/),
164         # If have mysql devel libraries installed
165         #q(s/^# LOOKUP_MYSQL=/LOOKUP_MYSQL=/),
166         # If have postgres devel librarires installed
167         #q(s/^# LOOKUP_PGSQL=/LOOKUP_PGSQL=/),
168         # Severl experimental features to consider
169         #q(s/^# EXPERIMENTAL_CERTNAMES.*/EXPERIMENTAL_CERTNAMES=yes/),
170         #q(s/^# EXPERIMENTAL_DNSSEC.*/EXPERIMENTAL_DNSSEC=yes/),
171         # Proxy causes some extra debug output messing with tests
172         #q(s/^# EXPERIMENTAL_PROXY.*/EXPERIMENTAL_PROXY=yes/),
173         #q(s/^# EXPERIMENTAL_TPDA.*/EXPERIMENTAL_TPDA=yes/),
174     ],
175
176     # The user compiled as the master exim username.
177     # Requirement: The buildfarm user that runs the build farm script *MUST* have
178     # the group of the exim user as a secondary group. Example:
179     # user=>farm, group=>farm, secondary_groups=>exim
180     # user=>exim, group=>exim
181     master_exim_user => "exim",
182
183     # Range of tests to run if enable make_test in optional steps.
184     #range_num_tests => '1 999',
185     range_num_tests => '1 5999',
186     # Hardcode some valid version for use during make test
187     exim_test_version => '4.84',
188
189     optional_steps =>{
190         # which optional steps to run and when to run them
191         # 'make-doc' => {min_hours_since => 24*7},
192         test  => {min_hours_since => 24*7},
193     },
194
195     # locales to test
196     locales => [qw( C )],
197
198     # Placemarker for auto-generated build features
199     config_opts =>[
200         qw()
201     ],
202
203 );
204
205 if ($branch eq 'global')
206 {
207
208     $conf{branches_to_build} = 'ALL';
209
210     # or 'HEAD_PLUS_LATEST' or 'HEAD_PLUS_LATEST2'
211     # or [qw( HEAD RELx_y_STABLE etc )]
212
213 }
214
215 ##################################
216 #
217 # Can use perl below for
218 # per branch processing.
219 #
220 ##################################
221
222 1;