Skip to content
play

GitHub Action

Install Vulkan SDK

v1.1.1 Latest version

Install Vulkan SDK

play

Install Vulkan SDK

Automatically downloads and installs prebuilt Vulkan SDK releases

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Install Vulkan SDK

              
  uses: humbletim/install-vulkan-sdk@v1.1.1
Learn more about this action in humbletim/install-vulkan-sdk

Choose a version

install-vulkan-sdk v1.1.1

test install-vulkan-sdk

This action automatically downloads and installs the Vulkan SDK development environment.

Usage

  -name: Install Vulkan SDK
   uses: humbletim/install-vulkan-sdk@v1.1.1
   with:
     version: 1.3.204.1
     cache: true

Parameters:

  • version (optional; default=latest): N.N.N.N style Vulkan SDK release number (or latest to use most recent official release).
  • cache (optional; default=false): boolean indicating whether to cache the downloaded installer file between builds.
  • quiet (optional; default=false): when using latest an Annotation is added to builds with actual SDK number; set quiet: true to silence.

SDK Revisions

Several recent SDK releases (known to have installers available for all three windows/mac/linux platforms):

  • 1.2.198.1
  • 1.3.204.1
  • 1.3.250.1
Available SDK versions (as of 2023.09.22):
  • windows.json: 1.3.261.1 / 1.3.250.1 / 1.3.243.0 / 1.3.239.0 / 1.3.236.0 / 1.3.231.1 / 1.3.224.1 / 1.3.216.0 / 1.3.211.0 / 1.3.204.1 / 1.2.198.1 / 1.2.189.2 / 1.2.189.0 / 1.2.182.0
  • linux.json: 1.3.261.1 / 1.3.250.1 / 1.3.243.0 / 1.3.239.0 / 1.3.236.0 / 1.3.231.2 / 1.3.231.1 / 1.3.224.1 / 1.3.216.0 / 1.3.211.0 / 1.3.204.1 / 1.2.198.1 / 1.2.189.0 / 1.2.182.0
  • mac.json: 1.3.261.1 / 1.3.250.1 / 1.3.243.0 / 1.3.239.0 / 1.3.236.0 / 1.3.231.1 / 1.3.224.1 / 1.3.216.0 / 1.3.211.0 / 1.3.204.1 / 1.2.198.1 / 1.2.189.0 / 1.2.182.0

Additional release numbers can be found at https://vulkan.lunarg.com/sdk/home.

Environment

Exported variables:

  • VULKAN_SDK (standard variable used by cmake and other build tools)
  • VULKAN_SDK_VERSION
  • VULKAN_SDK_PLATFORM
  • PATH is extended to include VULKAN_SDK/bin (so SDK tools like glslangValidator can be used directly)

Caveats

Please be aware that Vulkan SDKs can use a lot of disk space -- recently reported 1.3.204.0 installation sizes:

  • windows: 617M
  • linux: 631M
  • mac: 1.8G (1.3G of that being lib/libshaderc_combined.a)

If your project only depends on Vulkan-Headers and Vulkan-Loader to compile and link against then you may want to consider using humbletim/setup-vulkan-sdk instead, which allows building individual SDK components directly from Khronos source repos (and uses less disk space).

References