Google Git
Sign in
pigweed / infra / recipes / a98335648f5e7a2231684fb2f95d685c8a617980
commita98335648f5e7a2231684fb2f95d685c8a617980[log] [tgz]
authorRob Mohr <mohrr@google.com>Wed Oct 09 20:59:32 2024 +0000
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Oct 09 20:59:32 2024 +0000
tree992ce44235df98e62cc2b677de18f773be91e904
parent0279acd7c0343dde0389d24c308fab1f667ab337 [diff]
docs_builder: Make local copy of html

Make a local copy of the html directory since the Bazel html directory
isn't writeable.

Bug: b/372035428
Change-Id: If40d3647da2ac230ffb214cf31145242bb5a410a
Reviewed-on: https://pigweed-review.googlesource.com/c/infra/recipes/+/240952
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>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 992ce44235df98e62cc2b677de18f773be91e904
  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.