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