Google Git
Sign in
chromium / infra / luci / recipes-py / 08b7a23ec10abc078fd0f7594dd1331c76ae30e4
commit08b7a23ec10abc078fd0f7594dd1331c76ae30e4[log] [tgz]
authorStephen Martinis <martiniss@chromium.org>Wed Jan 09 00:45:35 2019
committerCommit Bot <commit-bot@chromium.org>Wed Jan 09 00:45:35 2019
treecaac88fee59fa49f886259f17127d842f1d28877
parent5e16623c2af04706ed78dec9aa25fcf367a2f0bc [diff]
Revert "Remove use_result_proto flag"

This reverts commit 5e16623c2af04706ed78dec9aa25fcf367a2f0bc.

Reason for revert: Seems to have broken bots, reverting.

Original change's description:
> Remove use_result_proto flag
> 
> Last bit of cleanup.
> 
> Bug: 646142
> Change-Id: I47e6431b8de2215ac8bbc6f35cc52003be0eb686
> Reviewed-on: https://chromium-review.googlesource.com/c/1381234
> Auto-Submit: Stephen Martinis <martiniss@chromium.org>
> Commit-Queue: Robbie Iannucci <iannucci@chromium.org>
> Reviewed-by: Robbie Iannucci <iannucci@chromium.org>

TBR=iannucci@chromium.org,martiniss@chromium.org

Change-Id: I8e3f6b5d008be8f277d8bfb39feb711bb5e2ac4b
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: 646142
Reviewed-on: https://chromium-review.googlesource.com/c/1401435
Reviewed-by: Stephen Martinis <martiniss@chromium.org>
Commit-Queue: Stephen Martinis <martiniss@chromium.org>
2 files changed
tree: caac88fee59fa49f886259f17127d842f1d28877
  1. doc/
  2. infra/
  3. misc/
  4. recipe_engine/
  5. recipe_modules/
  6. recipes/
  7. unittests/
  8. .gitattributes
  9. .gitignore
  10. .vpython
  11. AUTHORS
  12. codereview.settings
  13. CONTRIBUTORS
  14. LICENSE
  15. OWNERS
  16. PRESUBMIT.py
  17. README.md
  18. README.recipes.md
  19. 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.

Files

  • README.md

    This file!

  • doc/

    Documentation for the recipe engine (including this file!). See the design doc for more detailed design information about the recipe engine.

  • infra/

    Chrome infra config files.

  • recipes.py

    The main entry point to the recipe engine. It has many subcommands and flags; run recipes.py -h to see them. Include this in your repository to start using recipes.

  • recipes/

    Recipes in the recipe engine. These are either example recipes, or recipes which are used to test the engine (see run_test.py to see these run)

  • recipe_modules/

    Built in recipe modules. These are very useful when writing recipes; take a look in there, and look at each of their examples subfolders to get an idea how to use them in a recipe.

  • recipe_engine/

    The core functionality of the recipe engine. Noteworthy files include:

    • main.py -- The main entrypoint for the recipe engine.
    • package.proto -- The protobuf file which defines the format of a recipes.cfg file.
    • third_party/ -- third_party code which is vendored into the recipe engine.
    • recipe_api.py -- The api exposed to a recipe module.
    • unittests -- Unittests for the engine.

    There are also several files which correspond to a subcommand of recipes.py; depgraph, run, and autoroll are some examples.

  • unittests/

    Somewhat poorly named, these are higher level integration tests.

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:

git clone https://chromium.googlesource.com/chromium/tools/depot_tools.git $HOME/src/depot_tools
export PATH="$PATH:$HOME/src/depot_tools"
git checkout -b work origin/master

# 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.