Google Git
Sign in
pigweed / infra / recipes / ad4366c4fbb9c9c75d01a646d57fc36577d59f28
commitad4366c4fbb9c9c75d01a646d57fc36577d59f28[log] [tgz]
authorRob Mohr <mohrr@google.com>Mon Nov 20 17:37:58 2023 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Nov 20 17:37:58 2023 +0000
tree66cd697170de2855254e48d88375b0021d0a9d6a
parent7ff94c046993027866a25b7c33abba21d9b72d31 [diff]
static_checks: Use type annotations

Change-Id: I8afb26ea4e6692526bd94a44f08f6fe7a90bf477
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/181750
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Reviewed-by: Ted Pudlik <tpudlik@google.com>
1 file changed
tree: 66cd697170de2855254e48d88375b0021d0a9d6a
  1. infra/
  2. recipe_modules/
  3. recipes/
  4. scripts/
  5. black ⇨ .cipd/black
  6. .gitignore
  7. .style.yapf
  8. AUTHORS
  9. cipd.ensure
  10. LICENSE
  11. OWNERS
  12. presubmit.sh
  13. pyproject.toml
  14. README.md
  15. recipes.py
README.md

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 https://pigweed.googlesource.com/infra/recipes

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

git clone https://chromium.googlesource.com/chromium/tools/depot_tools ~/depot_tools
echo 'export PATH="$PATH:$HOME/depot_tools"' >> ~/.bashrc

Running Tests

./presubmit.sh runs three different sets of tests:

  • Recipe expectation tests (./recipes.py test train)
  • Formatting (./black --diff --check .)
  • Dependencies (.recipe_deps/fuchsia/scripts/cleanup_deps.py --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 ./presubmit.sh you'll need to run ./scripts/ensure_black.sh before ./black is present.