Google Git
Sign in
pigweed / infra / recipes / 8ea9f48b2923418cac2c9308cb3e8300419f7dba
commit8ea9f48b2923418cac2c9308cb3e8300419f7dba[log] [tgz]
authorRob Mohr <mohrr@google.com>Wed Oct 25 20:09:25 2023 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Oct 25 20:09:25 2023 +0000
treeb7b30686106b3fe7d26f35bdc0902532bf8a270e
parent6c65946378d1413f1d0e8d350f8d1f1cdbe07d79 [diff]
docs_builder: Only post comment on applied changes

This should avoid infra failures like in
http://ci.chromium.org/b/8766250488413519921.

Change-Id: Iba9535ff1e482f1d0a57343a4d1bca20f7909510
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/177795
Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com>
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Ted Pudlik <tpudlik@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: b7b30686106b3fe7d26f35bdc0902532bf8a270e
  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.