static_checks: Change how Readability works

Readability is now enforced by Gerrit and not by recipes, so recipe code
no longer fails if the Readability requirement isn't met. However, for
CLs that make only trivial modifications to files covered by
readability, recipes mark the CL as trivial, and Gerrit uses that to
bypass the readability requirement.

Bug: b/240290899
Change-Id: Icb16fe3456a3029f2281d39e87ae116f3533289d
Commit-Queue: Auto-Submit <>
Pigweed-Auto-Submit: Rob Mohr <>
Reviewed-by: Ted Pudlik <>
42 files changed
tree: d7ad698662b83460d4a0d5bf3b8c8b69b3b252af
  1. infra/
  2. recipe_modules/
  3. recipes/
  4. scripts/
  5. .gitignore
  6. .style.yapf
  8. cipd.ensure
  10. OWNERS
  12. pyproject.toml

Pigweed Recipes

This repository contains recipes for Pigweed.

A recipe is a Python script that runs a series of commands, using the recipe engine framework from the LUCI project. We use recipes to automatically check out, build, and test Pigweed and downstream projects using Pigweed in continuous integration jobs. The commands the recipes use are very similar to the ones you would use as a developer to check out, build, and test Pigweed in your local environment.

See go/pigweed-recipe-docs for complete documentation and a guide for getting started with writing recipes.

Getting the Code

The recommended way to get the source code is with git.

git clone

In most cases you will need a Chromium depot_tools checkout in your PATH as well.

git clone ~/depot_tools
echo 'export PATH="$PATH:$HOME/depot_tools"' >> ~/.bashrc

Running Tests

./ runs three different sets of tests:

  • Recipe expectation tests (./ test train)
  • Formatting (./black --diff --check .)
  • Dependencies (.recipe_deps/fuchsia/scripts/ --check)

The formatting check will tell you what‘s wrong but not fix it. For that you need to run ./black .. Similarly, the dependencies check will tell you what’s wrong but you'll need to edit the files to fix issues.

If not using ./ you'll need to run ./scripts/ before ./black is present.