Question 1

How do I set up run-cmake with a vcpkg manifest file?

Accepted Answer

Ensure you have a vcpkg.json in your project and use the run-vcpkg action before run-cmake. The run-cmake action will automatically use the vcpkg toolchain if configured in CMakePresets.json, as detailed in the quickstart instructions.

Question 2

run-cmake vs writing my own CMake steps in GitHub Actions?

Accepted Answer

run-cmake provides built-in features like error annotations and MSVC setup, reducing boilerplate. However, custom steps offer more flexibility for non-standard setups or if you need fine-grained control over CMake commands.

Question 3

Does run-cmake work with Conan or other package managers?

Accepted Answer

No, run-cmake is optimized for vcpkg integration. The README focuses on vcpkg, and while manual integration is possible, it's not supported out of the box, requiring extra configuration steps.

Question 4

How to handle multi-platform builds with different compilers?

Accepted Answer

Use CMakePresets.json to define presets for each platform and compiler, then reference them in the workflow. The action supports matrix strategies and automatically sets up environments like MSVC on Windows.

Question 5

What happens if my CMakePresets.json is missing or invalid?

Accepted Answer

The action will fail, as it requires a valid CMakePresets.json. Error logs are dumped automatically, but you must ensure the file is correctly structured and present in the repository.

Question 6

Can I use run-cmake without vcpkg for dependency management?

Accepted Answer

Yes, but vcpkg integration is a key feature. You can skip run-vcpkg and use other methods, but you'll lose automatic dependency handling and may need manual setup, contrary to the action's best practices.

run-cmake

What is run-cmake?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions