You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Windows is listed as an executor key, which can lead to some
confusion. Really, it's a machine image, and the orb is recommended
for ease of defining the executor, but this isn't immediately clear.
Copy file name to clipboardExpand all lines: jekyll/_cci2/configuration-reference.md
+17-1
Original file line number
Diff line number
Diff line change
@@ -89,12 +89,14 @@ docker | Y <sup>(1)</sup> | List | Options for [docker executor](#docker)
89
89
resource_class | N | String | Amount of CPU and RAM allocated to each container in a job. **Note:** A paid account is required to access this feature. Customers on paid container-based plans can request access by [opening a support ticket](https://support.circleci.com/hc/en-us/requests/new).
90
90
machine | Y <sup>(1)</sup> | Map | Options for [machine executor](#machine)
91
91
macos | Y <sup>(1)</sup> | Map | Options for [macOS executor](#macos)
92
-
windows | Y <sup>(1)</sup> | Map | Options for [windows executor](#windows)
92
+
windows* | Y <sup>(1)</sup> | Map | Options for [windows executor](#windows)
93
93
shell | N | String | Shell to use for execution command in all steps. Can be overridden by `shell` in each step (default: See [Default Shell Options](#default-shell-options))
94
94
working_directory | N | String | In which directory to run the steps.
95
95
environment | N | Map | A map of environment variable names and values.
96
96
{: class="table table-striped"}
97
97
98
+
* _the windows executor either uses a machine executor or an orb, and is not a standalone executor_
99
+
98
100
Example:
99
101
100
102
```yaml
@@ -493,6 +495,20 @@ jobs:
493
495
... // other config
494
496
```
495
497
498
+
The Orb is a wrapper around the `machine` executor to make configuration easier. This is the recommended
499
+
way of handling it, but it can be directly defined as well.
0 commit comments