Google Git
Sign in
chromium / infra / luci / recipes-py / 5754d5d1d5d4167e57136baee3f38a4e8d4dc206
commit5754d5d1d5d4167e57136baee3f38a4e8d4dc206[log] [tgz]
authorRobert Iannucci <iannucci@chromium.org>Tue May 14 04:20:56 2024
committerLUCI CQ <infra-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue May 14 04:20:56 2024
treec5458d19a8506c76f799de4e293dab3b85e530a6
parentf7da739e0368604b8ea51f2f6d1393ea2581a20c [diff]
Reland: Remove a bit of sys.path hackery.

Previously main.py would reconfigure sys.path during the execution of
the recipe code in order to make `from recipe_engine import ...` work.
This changes it so that main.py moves up a level, which will make all
known executions of main.py (namely recipes.py, the test runner and
the two bundled launcher scripts) automatically set PYTHONPATH
correctly.

Reland: Spurious quotes in generated .bat file caused invalid
PYTHONPATH entry... but the reland just moves main.py to make all
syspath manipulation unnecessary.

R=fancl, yiwzhang, mohrr

Bug: 1462728
Change-Id: If32c880caa5dc2084fb6255f0bfef392cba225c3
Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/recipes-py/+/5535275
Commit-Queue: Chenlin Fan <fancl@chromium.org>
Reviewed-by: Chenlin Fan <fancl@chromium.org>
Auto-Submit: Robbie Iannucci <iannucci@chromium.org>
5 files changed
tree: c5458d19a8506c76f799de4e293dab3b85e530a6
  1. doc/
  2. infra/
  3. misc/
  4. recipe_engine/
  5. recipe_modules/
  6. recipe_proto/
  7. recipes/
  8. unittests/
  9. .editorconfig
  10. .gitattributes
  11. .gitignore
  12. .pycharm.vpython3
  13. .style.yapf
  14. .vpython3
  15. .vscode.vpython3
  16. AUTHORS
  17. codereview.settings
  18. CONTRIBUTORS
  19. LICENSE
  20. main.py
  21. OWNERS
  22. PRESUBMIT.py
  23. pyproject.toml
  24. README.md
  25. README.recipes.md
  26. recipe.warnings
  27. recipes.py
README.md

Recipes

Recipes are a domain-specific language (embedded in Python) for specifying sequences of subprocess calls in a cross-platform and testable way.

They allow writing build flows which integrate with the rest of LUCI.

Documentation for the recipe engine (including this file!). Take a look at the user guide for some hints on how to get started. See the implementation details doc for more detailed implementation information about the recipe engine.

Contributing

  • Sign the Google CLA.
  • Make sure your user.email and user.name are configured in git config.

Run the following to setup the code review tool and create your first review:

# Get `depot_tools` in $PATH if you don't have it
git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools
export PATH="$PATH:$HOME/src/depot_tools"

# Check out the recipe engine repo
git clone https://chromium.googlesource.com/infra/luci/recipes-py $HOME/src/recipes-py

# make your change
cd $HOME/src/recipes-py
git new-branch cool_feature
# hack hack
git commit -a -m "This is awesome"

# This will ask for your Google Account credentials.
git cl upload -s -r joe@example.com
# Wait for approval over email.
# Click "Submit to CQ" button or ask reviewer to do it for you.
# Wait for the change to be tested and landed automatically.

Use git cl help and git cl help <cmd> for more details.