Name |
Date |
Size |
#Lines |
LOC |
||
---|---|---|---|---|---|---|
.. | - | - | ||||
config/ | 12-May-2024 | - | 542 | 506 | ||
recipe_modules/ | 12-May-2024 | - | 824 | 669 | ||
recipes/ | 12-May-2024 | - | 7,102 | 7,023 | ||
README.recipes.md | D | 12-May-2024 | 8.6 KiB | 140 | 91 | |
recipes.py | D | 12-May-2024 | 8.5 KiB | 266 | 175 |
README.recipes.md
1<!--- AUTOGENERATED BY `./recipes.py test train` --> 2# Repo documentation for [gn]() 3## Table of Contents 4 5**[Recipe Modules](#Recipe-Modules)** 6 * [macos_sdk](#recipe_modules-macos_sdk) (Python3 ✅) — The `macos_sdk` module provides safe functions to access a semi-hermetic XCode installation. 7 * [target](#recipe_modules-target) (Python3 ✅) 8 * [windows_sdk](#recipe_modules-windows_sdk) (Python3 ✅) 9 10**[Recipes](#Recipes)** 11 * [gn](#recipes-gn) (Python3 ✅) — Recipe for building GN. 12 * [macos_sdk:examples/full](#recipes-macos_sdk_examples_full) (Python3 ✅) 13 * [target:examples/full](#recipes-target_examples_full) (Python3 ✅) 14 * [windows_sdk:examples/full](#recipes-windows_sdk_examples_full) (Python3 ✅) 15## Recipe Modules 16 17### *recipe_modules* / [macos\_sdk](/infra/recipe_modules/macos_sdk) 18 19[DEPS](/infra/recipe_modules/macos_sdk/__init__.py#7): [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/step][recipe_engine/recipe_modules/step] 20 21PYTHON_VERSION_COMPATIBILITY: PY3 22 23The `macos_sdk` module provides safe functions to access a semi-hermetic 24XCode installation. 25 26Available only to Google-run bots. 27 28#### **class [MacOSSDKApi](/infra/recipe_modules/macos_sdk/api.py#14)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 29 30API for using OS X SDK distributed via CIPD. 31 32  **@contextmanager**<br>— **def [\_\_call\_\_](/infra/recipe_modules/macos_sdk/api.py#30)(self):** 33 34Sets up the XCode SDK environment. 35 36This call is a no-op on non-Mac platforms. 37 38This will deploy the helper tool and the XCode.app bundle at 39`[START_DIR]/cache/macos_sdk`. 40 41To avoid machines rebuilding these on every run, set up a named cache in 42your cr-buildbucket.cfg file like: 43 44 caches: { 45 # Cache for mac_toolchain tool and XCode.app 46 name: "macos_sdk" 47 path: "macos_sdk" 48 } 49 50If you have builders which e.g. use a non-current SDK, you can give them 51a uniqely named cache: 52 53 caches: { 54 # Cache for N-1 version mac_toolchain tool and XCode.app 55 name: "macos_sdk_old" 56 path: "macos_sdk" 57 } 58 59Usage: 60 with api.macos_sdk(): 61 # sdk with mac build bits 62 63Raises: 64 StepFailure or InfraFailure. 65 66  **@property**<br>— **def [sdk\_dir](/infra/recipe_modules/macos_sdk/api.py#25)(self):** 67### *recipe_modules* / [target](/infra/recipe_modules/target) 68 69[DEPS](/infra/recipe_modules/target/__init__.py#7): [recipe\_engine/platform][recipe_engine/recipe_modules/platform] 70 71PYTHON_VERSION_COMPATIBILITY: PY3 72 73#### **class [TargetApi](/infra/recipe_modules/target/api.py#82)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 74 75  **@property**<br>— **def [host](/infra/recipe_modules/target/api.py#87)(self):** 76### *recipe_modules* / [windows\_sdk](/infra/recipe_modules/windows_sdk) 77 78[DEPS](/infra/recipe_modules/windows_sdk/__init__.py#7): [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/step][recipe_engine/recipe_modules/step] 79 80PYTHON_VERSION_COMPATIBILITY: PY3 81 82#### **class [WindowsSDKApi](/infra/recipe_modules/windows_sdk/api.py#10)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 83 84API for using Windows SDK distributed via CIPD. 85 86  **@contextmanager**<br>— **def [\_\_call\_\_](/infra/recipe_modules/windows_sdk/api.py#19)(self):** 87 88Setups the Windows SDK environment. 89 90This call is a no-op on non-Windows platforms. 91 92Raises: 93 StepFailure or InfraFailure. 94## Recipes 95 96### *recipes* / [gn](/infra/recipes/gn.py) 97 98[DEPS](/infra/recipes/gn.py#10): [macos\_sdk](#recipe_modules-macos_sdk), [target](#recipe_modules-target), [windows\_sdk](#recipe_modules-windows_sdk), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/cas][recipe_engine/recipe_modules/cas], [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/file][recipe_engine/recipe_modules/file], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/python][recipe_engine/recipe_modules/python], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 99 100PYTHON_VERSION_COMPATIBILITY: PY3 101 102Recipe for building GN. 103 104— **def [RunSteps](/infra/recipes/gn.py#106)(api, repository):** 105### *recipes* / [macos\_sdk:examples/full](/infra/recipe_modules/macos_sdk/examples/full.py) 106 107[DEPS](/infra/recipe_modules/macos_sdk/examples/full.py#7): [macos\_sdk](#recipe_modules-macos_sdk), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 108 109PYTHON_VERSION_COMPATIBILITY: PY3 110 111— **def [RunSteps](/infra/recipe_modules/macos_sdk/examples/full.py#15)(api):** 112### *recipes* / [target:examples/full](/infra/recipe_modules/target/examples/full.py) 113 114[DEPS](/infra/recipe_modules/target/examples/full.py#7): [target](#recipe_modules-target), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 115 116PYTHON_VERSION_COMPATIBILITY: PY3 117 118— **def [RunSteps](/infra/recipe_modules/target/examples/full.py#15)(api):** 119### *recipes* / [windows\_sdk:examples/full](/infra/recipe_modules/windows_sdk/examples/full.py) 120 121[DEPS](/infra/recipe_modules/windows_sdk/examples/full.py#7): [windows\_sdk](#recipe_modules-windows_sdk), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 122 123PYTHON_VERSION_COMPATIBILITY: PY3 124 125— **def [RunSteps](/infra/recipe_modules/windows_sdk/examples/full.py#15)(api):** 126 127[recipe_engine/recipe_modules/buildbucket]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-buildbucket 128[recipe_engine/recipe_modules/cas]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-cas 129[recipe_engine/recipe_modules/cipd]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-cipd 130[recipe_engine/recipe_modules/context]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-context 131[recipe_engine/recipe_modules/file]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-file 132[recipe_engine/recipe_modules/json]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-json 133[recipe_engine/recipe_modules/path]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-path 134[recipe_engine/recipe_modules/platform]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-platform 135[recipe_engine/recipe_modules/properties]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-properties 136[recipe_engine/recipe_modules/python]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-python 137[recipe_engine/recipe_modules/raw_io]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-raw_io 138[recipe_engine/recipe_modules/step]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/README.recipes.md#recipe_modules-step 139[recipe_engine/wkt/RecipeApi]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/1b1ecd03e0b00399784c43add1465f685b6d1ab9/recipe_engine/recipe_api.py#883 140