Run Vcpkg

Abstract

1. Introduction

run-vcpkg@v11 requires vcpkg more recent than 2023-03-29 (e.g. commit id 5b1214315250939257ef5d62ecdcbca18cf4fb1c).

The run-vcpkg@v11 action setups (and optionally runs) vcpkg to install the packages specified in the vcpkg.json manifest file. It leverages the vcpkg's Binary Caching backed to GitHub Action cache, delegating cache and key management to vpckg.

Take a look at this C++ project template that applies all the following instructions, but also shows how to create a pure workflow without using special GitHub action that you cannot run locally on your development machine, but directly using the tools (CMake, Ninja, vcpkg, C++ compilers) you already use daily.

2. Objective

The GitHub Action to setup vcpkg for your C++ based projects. Stores built ports using Binary Caching backed onto GH Cache.

This project demonstrates how TypeScript, C++ can be applied to a real-world Blockchain & Cloud Computing problem.

4. Technology Stack

• starting CMake with the vcpkg.cmake toolchain file.
• the root CMake source directory contains a vcpkg.json file.

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Node.js (LTS) and npm / yarn / pnpm
• VS Code or any code editor
• Arduino IDE / PlatformIO or a C++ compiler (g++)
• Target board (e.g. Arduino, ESP32) where applicable
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/lukka/run-vcpkg.git
cd run-vcpkg

1. vcpkg as a submodule.
2. a vcpkg.json manifest file to declaratively specify the dependencies.
3. a CMakePresets.json file.
4. uses: lukka/get-cmake@latest
5. name: Setup anew (or from cache) vcpkg (and does not build any package)
6. name: Run CMake consuming CMakePreset.json and run vcpkg to build packages

with:
    configurePresetAdditionalArgs: "[ String.raw`-DD3D9_INCLUDE_DIR=${{ github.workspace }}/cache/Include` ]"

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add a CI/CD pipeline with GitHub Actions
• Deploy to a public test network or cloud free tier
• Add monitoring and cost alerts

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Why does this problem need a blockchain or cloud-native design?
2. Explain the smart contract / infrastructure components and how they interact.
3. How are gas costs or cloud costs kept under control?
4. How is the system secured (keys, IAM, access control)?
5. How would the solution scale to many more users?

9. Source Code & License

This project is developed by lukka and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.