Question 1

How do I set up run-vcpkg with CMakePresets.json in GitHub Actions?

Accepted Answer

Follow the quickstart instructions: use vcpkg as a submodule, specify vcpkg.json, and in your workflow, combine run-vcpkg with run-cmake, setting configurePreset to a preset that uses the vcpkg.cmake toolchain. This ensures vcpkg installs dependencies during CMake configuration.

Question 2

run-vcpkg or manual vcpkg setup in GitHub Actions, which is better?

Accepted Answer

run-vcpkg is better for automation: it handles caching and error reporting automatically, reducing boilerplate code. Manual setup offers more control but requires you to manage cache keys and error parsing yourself, which can be error-prone and time-consuming.

Question 3

Does run-vcpkg work with cross-compilation for different architectures?

Accepted Answer

Yes, by setting environment variables like VCPKG_DEFAULT_TRIPLET and VCPKG_DEFAULT_HOST_TRIPLET in your workflow, you can enforce specific triplets for cross-compilation. The action supports custom triplets as per vcpkg's capabilities.

Question 4

How can I speed up vcpkg bootstrap with run-vcpkg on ARM platforms?

Accepted Answer

Enable vcpkg executable caching by setting the input doNotCache to false; this caches the vcpkg binary since prebuilt executables might not be available for ARM, reducing bootstrap times in subsequent runs as mentioned in the features.

Question 5

What logs does run-vcpkg collect and how do I customize them?

Accepted Answer

It automatically dumps log files from CMake (e.g., CMakeOutput.log) and vcpkg, flowing them into workflow output. Customize by setting the input logCollectionRegExps with regex patterns to match specific log files you need.

Question 6

Can I use run-vcpkg without a vcpkg submodule?

Accepted Answer

Yes, but it's not recommended. You can specify vcpkgGitCommitId to fetch vcpkg from a Git repo, but using a submodule is highly suggested to pin the vcpkg version for consistency between local and CI environments, as per best practices.

run-vcpkg

What is run-vcpkg?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions