xref: /aosp_15_r20/external/crosvm/infra/config/README.md (revision bb4ee6a4ae7042d18b07a98463b9c8b875e44b39)
1*bb4ee6a4SAndroid Build Coastguard Worker# LUCI config
2*bb4ee6a4SAndroid Build Coastguard Worker
3*bb4ee6a4SAndroid Build Coastguard WorkerThis directory contains LUCI configuration.
4*bb4ee6a4SAndroid Build Coastguard Worker
5*bb4ee6a4SAndroid Build Coastguard Worker## Directory structure
6*bb4ee6a4SAndroid Build Coastguard Worker
7*bb4ee6a4SAndroid Build Coastguard Worker- [`main.star`](./main.star): The high-level LUCI configuration given as a
8*bb4ee6a4SAndroid Build Coastguard Worker  [Starlark](https://github.com/google/starlark-go) script. By processing this file with
9*bb4ee6a4SAndroid Build Coastguard Worker  [lucicfg](https://chromium.googlesource.com/infra/luci/luci-go/+/HEAD/lucicfg/README.md),
10*bb4ee6a4SAndroid Build Coastguard Worker  low-level \*.cfg will be generated under `./generated/`.
11*bb4ee6a4SAndroid Build Coastguard Worker- [`generated/`](./generated/): The directory containing \*.cfg generated from `main.star`.
12*bb4ee6a4SAndroid Build Coastguard Worker- [`recipes.cfg`](./recipes.cfg): The file defining the dependencies for our recipes such as
13*bb4ee6a4SAndroid Build Coastguard Worker  [modules](https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/HEAD/recipes/README.recipes.md#Recipe-Modules).
14*bb4ee6a4SAndroid Build Coastguard Worker  Whenever those dependencies are updated the
15*bb4ee6a4SAndroid Build Coastguard Worker  [Recipe Roller bot](https://chromium-review.googlesource.com/q/project:crosvm/crosvm+owner:recipe-mega-autoroller%2540chops-service-accounts.iam.gserviceaccount.com)
16*bb4ee6a4SAndroid Build Coastguard Worker  will update this file with the latest revision hashes.
17*bb4ee6a4SAndroid Build Coastguard Worker
18*bb4ee6a4SAndroid Build Coastguard Worker## Making changes
19*bb4ee6a4SAndroid Build Coastguard Worker
20*bb4ee6a4SAndroid Build Coastguard Worker1. Modify the `main.star`
21*bb4ee6a4SAndroid Build Coastguard Worker1. Run `./main.star`. Then, cfg file(s) in `generated/` are updated.
22*bb4ee6a4SAndroid Build Coastguard Worker1. Run `lucicfg validate main.star`. This will send the config to LUCI to verify the generated
23*bb4ee6a4SAndroid Build Coastguard Worker   config is valid.
24