| commit | 8933cb3e96fe926d73f21f02f0cae658b0dfc7cf | [log] [tgz] |
|---|---|---|
| author | Theodore Siu <theosiu@google.com> | Sun Aug 14 18:53:03 2022 +0000 |
| committer | releases-try-builder <releases-try-builder@fuchsia-infra.iam.gserviceaccount.com> | Mon Aug 22 20:46:48 2022 +0000 |
| tree | b61e3f2d88df64478af835c1740817eb19bf7bf5 | |
| parent | 9c9ab64bd31135a4df96bc4a27f3f4e0d63d5a52 [diff] |
[docsgen] Add branching to reference docs recipe Bug: 105841 This infra change is setup to allow for generating reference docs for specific fuchsia release branches landing in fuchsia.dev. See https://docs.google.com/document/d/1TMmTB98ze0m9C9RJe98vY90FQV4q4OErLth4KTfcKAU/edit# for more details. Change-Id: I1909e2be98d896f3c8c2e0f02fc2f96e5cd213bc Reviewed-on: https://fuchsia-review.googlesource.com/c/infra/recipes/+/707943 Reviewed-by: Oliver Newman <olivernewman@google.com> Commit-Queue: Theodore Siu <theosiu@google.com> (cherry picked from commit 952478219c393a54da688aff083c705e7dcc1bff)
This repository contains recipes for Fuchsia.
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 Fuchsia 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 Fuchsia in your local environment.
See go/fuchsia-recipe-docs for complete documentation and a guide for getting started with writing recipes.
The recommended way to get the source code is with jiri. A recipe will not run without vpython and cipd, and using these recommended jiri manifests will ensure that you have these tools.
You can use the fuchsia infra Jiri manifest or the internal version (Googlers-only). Once that manifest is imported in your local jiri manifest, jiri update should download vpython and cipd into <JIRI ROOT>/fuchsia-infra/prebuilt/tools/. If you add that directory to your PATH, you should be good to go.
If you're just trying to make a single small change to in this repository and already have your local environment set up for recipe development (e.g. because you work with another recipes repository) you can simply clone this repository with git:
git clone https://fuchsia.googlesource.com/infra/recipes
Then it will be up to you to ensure that vpython and cipd are available in your PATH.
We format python code using Black, an open-source Python autoformatter. It should be in your PATH if you followed the instructions for setting up your environment.
After committing recipe changes, you can format the files in your commit by running black . in your project root.
Many editors also have a setting to run Black automatically whenever you save a Python file (or on a keyboard shortcut). For VS Code, add the following to your workspace settings.json to make your editor compatible with Black and turn on auto-formatting on save:
{ "python.formatting.provider": "black", "python.formatting.blackPath": "<absolute path to the black executable>", "[python]": { "editor.formatOnSave": true, "editor.rulers": [88], // Black enforces a line length of 88 characters. }, ... }