Skip to content

Commit f8c3719

Browse files
author
Gabriel Simmer
committed
Clarify windows executor is a wrapper for machine
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.
1 parent e4b7f59 commit f8c3719

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

jekyll/_cci2/configuration-reference.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,14 @@ docker | Y <sup>(1)</sup> | List | Options for [docker executor](#docker)
8989
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).
9090
machine | Y <sup>(1)</sup> | Map | Options for [machine executor](#machine)
9191
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)
9393
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))
9494
working_directory | N | String | In which directory to run the steps.
9595
environment | N | Map | A map of environment variable names and values.
9696
{: class="table table-striped"}
9797

98+
* _the windows executor either uses a machine executor or an orb, and is not a standalone executor_
99+
98100
Example:
99101

100102
```yaml
@@ -493,6 +495,20 @@ jobs:
493495
... // other config
494496
```
495497

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.
500+
501+
```yaml
502+
jobs:
503+
build:
504+
machine:
505+
image: windows-server-2019-vs2019:201908-06
506+
resource_class: windows.medium
507+
shell: bash
508+
steps:
509+
... // other config
510+
```
511+
496512
##### GPU Executor (Linux)
497513

498514
Class | vCPUs | Memory (GiB) | GPUs | GPU Memory (*GiB)

0 commit comments

Comments
 (0)