Set umask only if not 022 already, print a notice about doing thata
[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://buildfarm.exim.org/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://buildfarm.exim.org/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     # allow automatic updates of the buildfarm client code.
70     # Leave it *unset* to get the default behaviour, set it
71     # to some false value to disable automatic updates or set it
72     # to the name of the remote Git repo you follow for your
73     # buildfarm-client code.
74     #auto_update => 'origin',
75
76     # if force_every is a scalar it will be used on all branches, like this
77     # for legacy reasons:
78     # force_every => 336 , # max hours between builds, undef or 0 = unforced
79     # we now prefer it to be a hash with branch names as the keys, like this
80     #
81     # this setting should be kept conservatively high, or not used at all  -
82     # for the most part it's best to let the script decide if something
83     # has changed that requires a new run for the branch.
84     #
85     # an entry with a name of 'default' matches any branch not named
86     force_every => {
87         HEAD => 24*7,
88         # default => 168,
89     },
90
91     # alerts are triggered if the server doesn't see a build on a branch after
92     # this many hours, and then sent out every so often,
93     alerts => {
94         #HEAD          => { alert_after => 72,  alert_every => 24 },
95     },
96
97     print_success => undef,
98
99     # include / exclude pattern for files whose trigger a build
100     # if both are specified then they are both applied as filters
101     # undef means don't ignore anything.
102     # exclude qr[/(doc|po)/] to ignore changes to docs and po files (recommended)
103     # undef means null filter.
104     trigger_exclude => qr[/(doc|po)/],
105     trigger_include => undef,
106
107     # settings for mail notices - default to notifying nobody
108     # these lists contain addresses to be notified
109     # must be complete email addresses, as the email is sent from the server
110     mail_events =>{
111         all => [], # unconditional
112         fail => [], # if this build fails
113         change => [], # if this build causes a state change
114         green => [], # if this build causes a state change to/from OK
115     },
116
117     # env settings to apply within build/report process
118     # these settings will be seen by all the processes, including the
119     # configure process.
120     build_env =>{
121         # use a dedicated cache for the build farm. this should give us
122         # very high hit rates and slightly faster cache searching.
123         CCACHE_DIR => "/home/$farm_user_name/buildfarm/ccache/$branch",
124
125         ### set this if you need a proxy setting for the
126         # outbound web transaction that reports the results
127         # BF_PROXY => 'http://my.proxy.server:portnum/',
128     },
129
130     # Environment settings on the make commandline.
131     # These cause full compile output and don't strip the binary.
132     make_args => q/FULLECHO='' STRIP_COMMAND=''/,
133
134     # Settings to add to Local/Makefile. These will set or override
135     # previous definitions of variables.  Example:
136     # LDFLAGS => '-Wall' will create LDFLAGS = '-Wall'
137     makefile_set =>{
138         # comment out if not using ccache
139         CC => 'ccache gcc',
140         # Required for some tests to pass
141         AUTH_PLAINTEXT => 'yes',
142         SUPPORT_MAILDIR => 'yes',
143         # Other examples. Could use makefile_regex instead.
144         #SUPPORT_TLS => 'yes',
145         #USE_OPENSSL_PC => 'openssl',
146         #TLS_LIBS => '-lssl -lcrypto',
147         #EXPERIMENTAL_SPF => 'yes',
148         #LOOKUP_LDAP => 'yes',
149         #LOOKUP_INCLUDE => '-I/usr/include/mysql',
150         #LOOKUP_LIBS => '-lmysqlclient -lpq -lldap -llber',
151         #LDAP_LIB_TYPE => 'OPENLDAP2',
152     },
153     # Settings to add to Local/Makefile. These will add to variables that
154     # are already defined earlier in the Makefile.  Example:
155     # LDFLAGS => '-Wall'  will create  LDFLAGS+='-Wall'
156     makefile_add =>{
157         # Show all warnings and errors
158         CFLAGS => '-Wall -Werror=format-security',
159         # Or enable debugging flags
160         #CFLAGS => '-g -Wall',
161         #LFLAGS => '-g',
162         # If set EXPERIMENTAL_SPF above, add it to the linker:
163         #LDFLAGS => '-lspf2',
164     },
165
166     # Another way to enable things in the Local/Makefile.
167     # Use a simple regex to change a default to what you want.
168     makefile_regex =>[
169         # If have perl devel libraries installed, can build embedded perl
170         #q(s/^# EXIM_PERL=/EXIM_PERL=/),
171         # If have mysql devel libraries installed
172         #q(s/^# LOOKUP_MYSQL=/LOOKUP_MYSQL=/),
173         # If have postgres devel librarires installed
174         #q(s/^# LOOKUP_PGSQL=/LOOKUP_PGSQL=/),
175         # Severl experimental features to consider
176         #q(s/^# EXPERIMENTAL_CERTNAMES.*/EXPERIMENTAL_CERTNAMES=yes/),
177         #q(s/^# EXPERIMENTAL_DNSSEC.*/EXPERIMENTAL_DNSSEC=yes/),
178         # Proxy causes some extra debug output messing with tests
179         #q(s/^# EXPERIMENTAL_PROXY.*/EXPERIMENTAL_PROXY=yes/),
180         #q(s/^# EXPERIMENTAL_TPDA.*/EXPERIMENTAL_TPDA=yes/),
181     ],
182
183     # The user compiled as the master exim username.
184     # Requirement: The buildfarm user that runs the build farm script *MUST* have
185     # the group of the exim user as a secondary group. Example:
186     # user=>farm, group=>farm, secondary_groups=>exim
187     # user=>exim, group=>exim
188     master_exim_user => "exim",
189
190     # Range of tests to run if enable make_test in optional steps.
191     #range_num_tests => '1 999',
192     range_num_tests => '1 5999',
193     # Hardcode some valid version for use during make test
194     exim_test_version => '4.84',
195
196     optional_steps =>{
197         # which optional steps to run and when to run them
198         # 'make-doc' => {min_hours_since => 24*7},
199         test  => {min_hours_since => 24*7},
200     },
201
202     # locales to test
203     locales => [qw( C )],
204
205     # Placemarker for auto-generated build features
206     config_opts =>[
207         qw()
208     ],
209
210 );
211
212 if ($branch eq 'global')
213 {
214
215     $conf{branches_to_build} = 'ALL';
216
217     # or 'HEAD_PLUS_LATEST' or 'HEAD_PLUS_LATEST2'
218     # or [qw( HEAD RELx_y_STABLE etc )]
219
220 }
221
222 ##################################
223 #
224 # Can use perl below for
225 # per branch processing.
226 #
227 ##################################
228
229 1;