1. circleci/windows@5.1.0

circleci/windows@5.1.0

Certified
Sections
Execute your CI pipelines on Windows in the cloud with Nvidia GPU support.
Created: August 6, 2019Version Published: February 4, 2025Releases: 15
Org Usage:
729

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: windows: circleci/windows@5.1.0

Use windows elements in your existing workflows and jobs.

Usage Examples

run_default

This is an example of running a simple job on the default Windows executor

1 2 3 4 5 6 7 8 9 10 11 12 13 14 version: '2.1' orbs: win: circleci/windows@5.0 jobs: build: executor: name: win/default steps: - checkout - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build

run_windows_2019

This is an example of running a simple job on the Windows Server 2019 executor

1 2 3 4 5 6 7 8 9 10 11 12 version: '2.1' orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2019 steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build

run_windows_2019_cuda

This is an example of running a simple job on the Windows Server 2019 cuda (GPU) executor

1 2 3 4 5 6 7 8 9 10 11 12 version: '2.1' orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2019-cuda steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build

run_windows_2022

This is an example of running a simple job on the Windows Server 2022 executor

1 2 3 4 5 6 7 8 9 10 11 12 version: '2.1' orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2022 steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build

run_windows_2022_cuda

This is an example of running a simple job on the Windows Server 2022 cuda (GPU) executor

1 2 3 4 5 6 7 8 9 10 11 12 version: '2.1' orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2022-cuda steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build

Executors

default

An executor preloaded with Visual Studio 2022 plus a number of other development tools.

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
shell
The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass`
No
powershell.exe -ExecutionPolicy Bypass
string
size
The size of Windows resource to use. Defaults to medium.
No
medium
enum
variant
The variant of windows server 2022. Defaults to gui.
No
gui
enum
version
The image version to use when executing. Defaults to "current".
No
current
string

server-2019

An executor preloaded with Visual Studio 2019 plus a number of other development tools.

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
shell
The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass`
No
powershell.exe -ExecutionPolicy Bypass
string
size
The size of Windows resource to use. Defaults to medium.
No
medium
enum
variant
The variant of Windows Server 2019. Defaults to vs2019.
No
vs2019
enum
version
The image version to use when executing. Defaults to "current".
No
current
string

server-2019-cuda

An executor with an Nvidia GPU which includes a pre-installed CUDA runtime and the cuDNN library.

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
shell
The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass`
No
powershell.exe -ExecutionPolicy Bypass
string
size
The size of Windows GPU resource to use. Defaults to medium.
No
medium
enum
version
The image version to use when executing. Defaults to "current".
No
current
string

server-2022

An executor preloaded with Visual Studio 2022 plus a number of other development tools.

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
shell
The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass`
No
powershell.exe -ExecutionPolicy Bypass
string
size
The size of Windows resource to use. Defaults to medium.
No
medium
enum
variant
The variant of Windows Server 2022. Defaults to gui.
No
gui
enum
version
The image version to use when executing. Defaults to "current".
No
current
string

server-2022-cuda

An executor with an Nvidia GPU which includes a pre-installed CUDA runtime.

Show executor Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
shell
The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass`
No
powershell.exe -ExecutionPolicy Bypass
string
size
The size of Windows GPU resource to use. Defaults to medium.
No
medium
enum
version
The image version to use when executing. Defaults to "current".
No
current
string

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: Execute your CI pipelines on Windows in the cloud with Nvidia GPU support. display: home_url: https://circleci.com/build-environments/windows source_url: https://github.com/CircleCI-Public/windows-orb executors: default: description: | An executor preloaded with Visual Studio 2022 plus a number of other development tools. machine: image: windows-server-2022-<< parameters.variant >>:<< parameters.version >> resource_class: windows.<< parameters.size >> shell: << parameters.shell >> parameters: shell: default: powershell.exe -ExecutionPolicy Bypass description: The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass` type: string size: default: medium description: The size of Windows resource to use. Defaults to medium. enum: - medium - large - xlarge - 2xlarge type: enum variant: default: gui description: The variant of windows server 2022. Defaults to gui. enum: - gui type: enum version: default: current description: The image version to use when executing. Defaults to "current". type: string server-2019: description: | An executor preloaded with Visual Studio 2019 plus a number of other development tools. machine: image: windows-server-2019-<< parameters.variant >>:<< parameters.version >> resource_class: windows.<< parameters.size >> shell: << parameters.shell >> parameters: shell: default: powershell.exe -ExecutionPolicy Bypass description: The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass` type: string size: default: medium description: The size of Windows resource to use. Defaults to medium. enum: - medium - large - xlarge - 2xlarge type: enum variant: default: vs2019 description: The variant of Windows Server 2019. Defaults to vs2019. enum: - vs2019 type: enum version: default: current description: The image version to use when executing. Defaults to "current". type: string server-2019-cuda: description: | An executor with an Nvidia GPU which includes a pre-installed CUDA runtime and the cuDNN library. machine: image: windows-server-2019-cuda:<< parameters.version >> resource_class: windows.gpu.nvidia.<< parameters.size >> shell: << parameters.shell >> parameters: shell: default: powershell.exe -ExecutionPolicy Bypass description: The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass` type: string size: default: medium description: The size of Windows GPU resource to use. Defaults to medium. enum: - medium type: enum version: default: current description: The image version to use when executing. Defaults to "current". type: string server-2022: description: | An executor preloaded with Visual Studio 2022 plus a number of other development tools. machine: image: windows-server-2022-<< parameters.variant >>:<< parameters.version >> resource_class: windows.<< parameters.size >> shell: << parameters.shell >> parameters: shell: default: powershell.exe -ExecutionPolicy Bypass description: The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass` type: string size: default: medium description: The size of Windows resource to use. Defaults to medium. enum: - medium - large - xlarge - 2xlarge type: enum variant: default: gui description: The variant of Windows Server 2022. Defaults to gui. enum: - gui type: enum version: default: current description: The image version to use when executing. Defaults to "current". type: string server-2022-cuda: description: | An executor with an Nvidia GPU which includes a pre-installed CUDA runtime. machine: image: windows-server-2022-cuda:<< parameters.version >> resource_class: windows.gpu.nvidia.<< parameters.size >> shell: << parameters.shell >> parameters: shell: default: powershell.exe -ExecutionPolicy Bypass description: The shell to use. Defaults to `powershell.exe -ExecutionPolicy Bypass` type: string size: default: medium description: The size of Windows GPU resource to use. Defaults to medium. enum: - medium type: enum version: default: current description: The image version to use when executing. Defaults to "current". type: string examples: run_default: description: This is an example of running a simple job on the default Windows executor usage: version: "2.1" orbs: win: circleci/windows@5.0 jobs: build: executor: name: win/default steps: - checkout - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build run_windows_2019: description: | This is an example of running a simple job on the Windows Server 2019 executor usage: version: "2.1" orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2019 steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build run_windows_2019_cuda: description: | This is an example of running a simple job on the Windows Server 2019 cuda (GPU) executor usage: version: "2.1" orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2019-cuda steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build run_windows_2022: description: | This is an example of running a simple job on the Windows Server 2022 executor usage: version: "2.1" orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2022 steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build run_windows_2022_cuda: description: | This is an example of running a simple job on the Windows Server 2022 cuda (GPU) executor usage: version: "2.1" orbs: win: circleci/windows@5.0 jobs: build: executor: win/server-2022-cuda steps: - run: Write-Host 'Hello, Windows' workflows: my-workflow: jobs: - build
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.