aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 20e0b6470adfdf810257a15c41883462696b0723 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
This repo is designed to work in conjuction yocto-autobuilder. Whilst
yocto-autobuilder is designed to cover all releases, this repo has a branch per
release and contains the hooks that do the actual build configuration and execution.

pre-commit-hook.sh can be used to verify the JSON before committing, symlink this
to .git/hooks/pre-commit (ln -s ../../scripts/pre-commit-hook.sh .git/hooks/pre-commit).

Its likely most users will end up having to customise this repository for their needs. The
scripts themselves should be more generically reusable, the config.json, less so as it 
represents the Yocto Project Autobuilder test matrix.

There are two customisation options possible, one is through variable substitution, the other
is through overlaying configuration files. The standard config.json tries to at least allow
substitution of the paths. A local-example.json is included to show how you could override
these from a separate config file, simply passing:

ABHELPER_JSON="config.json local-example.json"

into the environment of the autobuilder.

ABHELPER_JSON="config.json /some/location/local.json"

would also allow customisation.

Authors: 
  Richard Purdie <richard.purdie@linuxfoundation.org>
  Joshua Lock <joshua.g.lock@intel.com>

Contributions:

Patches for this code should be sent to the yocto@lists.yoctoproject.org mailing list
with [yocto-autobuilder-helper] in the subject.  This can be configured automatically
with the following commands:

  git config  --local --add format.subjectprefix 'yocto-autobuilder-helper][PATCH'
  git config  --local --add sendemail.to yocto@lists.yoctoproject.org

When sending single patches, please use something like:
git send-email -M -1 --to=yocto@lists.yoctoproject.org --subject-prefix='yocto-autobuilder-helper][PATCH'