8037b62312
Docs-Preview: https://skia.org/?cl=56020 Change-Id: I7d28d7921ab9c650498f4f8a06533f7e5df19a36 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/56020 Auto-Submit: Ben Wagner <benjaminwagner@google.com> Commit-Queue: Eric Boren <borenet@google.com> Reviewed-by: Eric Boren <borenet@google.com>
97 lines
3.0 KiB
Markdown
97 lines
3.0 KiB
Markdown
Skia Infrastructure
|
|
===================
|
|
|
|
This directory contains infrastructure elements.
|
|
|
|
|
|
Tasks and Jobs
|
|
--------------
|
|
|
|
Files in this directory define a DAG of tasks which run at every Skia commit. A
|
|
task is a small, self-contained unit which runs via Swarming on a machine in the
|
|
pool. Tasks may be chained together, eg. one task to compile test binaries and
|
|
another to actually run them.
|
|
|
|
Jobs are collections of related tasks which help define sub-sections of the DAG,
|
|
for example, to be used as try jobs. Each job is defined as an entry point into
|
|
the DAG.
|
|
|
|
The tasks.json file in this directory is the master list of tasks and jobs for
|
|
the repo. Note that tasks.json is NEVER edited by hand but generated via
|
|
gen_task.go and the input files enumerated below. The
|
|
[Task Scheduler](https://skia.googlesource.com/buildbot/+/master/task_scheduler/README.md)
|
|
reads the tasks.json file at each commit to determine which jobs to run. For
|
|
convenience, gen_tasks.go is provided to generate tasks.json and also to test it
|
|
for correct syntax and detecting cycles and orphaned tasks. Always edit
|
|
gen_tasks.go or one of the following input JSON files, rather than tasks.json
|
|
itself:
|
|
|
|
* cfg.json - Basic configuration information for gen_tasks.go.
|
|
* jobs.json - The master list of all jobs to run. Edit this to add or remove
|
|
bots.
|
|
|
|
Whenever gen_tasks.go, any of the above JSON files, or assets are changed, you
|
|
need to run gen_tasks.go to regenerate tasks.json:
|
|
|
|
$ go run infra/bots/gen_tasks.go
|
|
|
|
Or:
|
|
|
|
$ cd infra/bots; make train
|
|
|
|
There is also a test mode which performs sanity-checks and verifies that
|
|
tasks.json is unchanged:
|
|
|
|
$ go run infra/bots/gen_tasks.go --test
|
|
|
|
Or:
|
|
|
|
$ cd infra/bots; make test
|
|
|
|
|
|
Recipes
|
|
-------
|
|
|
|
Recipes are the framework used by Skia's infrastructure to perform work inside
|
|
of Swarming tasks. The main elements are:
|
|
|
|
* recipes.py - Used for running and testing recipes.
|
|
* recipes - These are the entry points for each type of task, eg. compiling
|
|
or running tests.
|
|
* recipe_modules - Shared modules which are used by recipes.
|
|
* .recipe_deps - Recipes and modules may depend on modules from other repos.
|
|
The recipes.py script automatically syncs those dependencies in this
|
|
directory.
|
|
|
|
|
|
Isolate Files
|
|
-------------
|
|
|
|
These files determine which parts of the repository are transferred to the bot
|
|
when a Swarming task is triggered. The
|
|
[Isolate tool](https://github.com/luci/luci-py/tree/master/appengine/isolate/doc)
|
|
hashes each file and will upload any new/changed files. Bots maintain a cache so
|
|
that they can efficiently download only the files they don't have.
|
|
|
|
|
|
Assets
|
|
------
|
|
|
|
Artifacts used by the infrastructure are versioned here, along with scripts for
|
|
recreating/uploading/downloading them. See the README in that directory for more
|
|
information. Any time an asset used by the bots changes, you need to re-run
|
|
gen_tasks.go.
|
|
|
|
|
|
Tools
|
|
-----
|
|
|
|
Assorted other infrastructure-related tools, eg. isolate and CIPD binaries.
|
|
|
|
|
|
CT
|
|
--
|
|
|
|
Helpers for running Skia tasks in Cluster Telemetry.
|
|
|