Google Git
Sign in
pigweed / infra / recipes / aab51668e9b9b81131495f7119e7d30b87f48ae3
commitaab51668e9b9b81131495f7119e7d30b87f48ae3[log] [tgz]
authorRob Mohr <mohrr@google.com>Fri Nov 10 22:45:09 2023 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Fri Nov 10 22:45:09 2023 +0000
tree33eb3b3765d7693c4804e13ecfc8fb6f25193e71
parent43586aaf9a42a663ccc7eeb3099796e3bc796b59 [diff]
util: Update attrs and add type annotations

Change-Id: Ia916890d9a364d07fd77eaf13866eddaf8eb8d20
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/180458
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
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>
Reviewed-by: Ted Pudlik <tpudlik@google.com>
1 file changed
tree: 33eb3b3765d7693c4804e13ecfc8fb6f25193e71
  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.