crosvm/infra/config/README.md
Keiichi Watanabe c89cf4b332 infra: Add README about /config
BUG=none
TEST=./tools/fmt

Change-Id: Icafcb0a9fd5f84ea9d5f18e962f02046ed4ff46e
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/3802636
Commit-Queue: Keiichi Watanabe <keiichiw@chromium.org>
Tested-by: Keiichi Watanabe <keiichiw@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
2022-08-16 14:23:53 +00:00

23 lines
1.2 KiB
Markdown

# LUCI config
This directory contains LUCI configuration.
## Directory structure
- [`main.star`](./main.star): The high-level LUCI configuration given as a
[Starlark](https://github.com/google/starlark-go) script. By processing this file with
[lucicfg](https://chromium.googlesource.com/infra/luci/luci-go/+/HEAD/lucicfg/README.md),
low-level \*.cfg will be generated under `./generated/`.
- [`generated/`](./generated/): The directory containing \*.cfg generated from `main.star`.
- [`recipes.cfg`](./recipes.cfg): The file defining the dependencies for our recipes such as
[modules](https://chromium.googlesource.com/chromium/tools/depot_tools.git/+/HEAD/recipes/README.recipes.md#Recipe-Modules).
Whenever those dependencies are updated the
[Recipe Roller bot](https://chromium-review.googlesource.com/q/project:crosvm/crosvm+owner:recipe-mega-autoroller%2540chops-service-accounts.iam.gserviceaccount.com)
will update this file with the latest revision hashes.
## Making changes
1. Modify the `main.star`
1. Run `./main.star`. Then, cfg file(s) in `generated/` are updated.
1. Run `lucicfg validate main.star`. This will send the config to LUCI to verify the generated
config is valid.