Google Git
Sign in
pigweed / infra / recipes / ad93d5cdf8bc56ed37451ea0429bb00c752d5ad6
commitad93d5cdf8bc56ed37451ea0429bb00c752d5ad6[log] [tgz]
authorRob Mohr <mohrr@google.com>Mon Sep 09 20:42:57 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Mon Sep 09 20:42:57 2024 +0000
tree3e3c307adfe9752f5edb591311f64b863481d442
parent138fc2b33fbf2a95565d6fd0f2ed986042d76822 [diff]
static_checks: Support Docs-Not-Needed label

Bug: b/365581180
Change-Id: If2ad95eee9409c25edae2634bf8e1853d6db033a
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/234871
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: 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>
2 files changed
tree: 3e3c307adfe9752f5edb591311f64b863481d442
  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.