Google Git
Sign in
pigweed / infra / recipes / ff2be5ecfb32a67b5bd9603fb6ddec15d7858b88
commitff2be5ecfb32a67b5bd9603fb6ddec15d7858b88[log] [tgz]
authorRob Mohr <mohrr@google.com>Mon Oct 07 22:37:48 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Oct 07 22:37:48 2024 +0000
tree549c18919140dba583f693e2eed2d7b137431166
parente364394ed37220ab35de3726caf4f4d787613952 [diff]
docs_builder: Add Bazel support

Bug: b/372035428
Change-Id: I58c05a849d81a2493e13829bcbf351970fa2a140
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/240772
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Reviewed-by: Ted Pudlik <tpudlik@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
3 files changed
tree: 549c18919140dba583f693e2eed2d7b137431166
  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.