Skip to content

Commit

Permalink
Add doc about contexts property (flutter#3442)
Browse files Browse the repository at this point in the history
Adding doc for `contexts`.
  • Loading branch information
keyonghan authored Jan 26, 2024
1 parent b43a53e commit 21a8d58
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions CI_YAML.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ owner in [TESTOWNERS](https://github.com/flutter/flutter/blob/master/TESTOWNERS)
Targets support specifying properties that can be passed throughout infrastructure. The
following are a list of keys that are reserved for special use.

**Properties is a Map<String, String> and any special values must be JSON encoded
(i.e. no trailing commas). Additionally, these strings must be compatible with YAML multiline strings**
**Properties** is a Map<String, String> and any special values must be JSON encoded
(i.e. no trailing commas). Additionally, these strings must be compatible with YAML multiline strings

**$flutter/osx_sdk**: xcode configs including sdk and runtime. **Note**: support on legacy `xcode`/`runtime`
properties and `xcode` dependency has been deprecated.
Expand Down Expand Up @@ -188,6 +188,17 @@ Example
presubmit_max_attempts: "3"
```

**contexts** The list of contexts that will guide [recipes](https://flutter.googlesource.com/recipes/+/refs/heads/main/recipe_modules/flutter_deps/api.py#665) to add to [ExitStack](https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack).

Example
```yaml
contexts: >-
[
"android_virtual_device"
]
```
This will initialize and prepare the virtual device used for tests. Other supported contexts include: `osx_sdk`, `depot_tools_on_path`, etc.

### Updating targets

#### Properties
Expand Down

0 comments on commit 21a8d58

Please sign in to comment.