Google Git
Sign in
pigweed / infra / recipes / 19ba58cba2f5f621bd3a14b1c9178685b3c1ff99
commit19ba58cba2f5f621bd3a14b1c9178685b3c1ff99[log] [tgz]
authorRob Mohr <mohrr@google.com>Mon Jun 10 21:24:40 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Jun 10 21:24:40 2024 +0000
treedc22a371e947a314d4486baa2d55192bf310e6e9
parent4940b5107239d7178daa20e9041ef970d6595faf [diff]
repo_roller: Reformat with black

Change-Id: I372bd3b2a89efe7f92f5cf3fc614fa167bc2dec4
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/215311
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Wyatt Hepler <hepler@google.com>
1 file changed
tree: dc22a371e947a314d4486baa2d55192bf310e6e9
  1. infra/
  2. recipe_modules/
  3. recipes/
  4. scripts/
  5. black ⇨ .cipd/black
  6. .editorconfig
  7. .gitignore
  8. .style.yapf
  9. AUTHORS
  10. cipd.ensure
  11. LICENSE
  12. OWNERS
  13. presubmit.sh
  14. pyproject.toml
  15. README.md
  16. 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.