vcpkg-action

vcpkg-action is a simple action to build and cache vcpkg packages. It supports all platforms. It has unique features:

• Simplicity
• Use of a "dry-run" build to generate a unique cache key for the configuration.
• Optionally supports reading vcpkg.json manifest files

vcpkg is cloned to the ${{ github.workspace }}/vcpkg directory, and the build products are located in ${{ github.workspace }}/vcpkg/installed/<triplet>. For cmake, use the option:

 -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=<triplet> -DVCPKG_MANIFEST_MODE=OFF

An output vcpkg-cmake-config is also created to simplify setting cmake configuration settings. Example usage:

cmake ${{ steps.vcpkg.outputs.vcpkg-cmake-config }} -S <src_dir> -B <build_dir>

Include other configuration settings as normal in the cmake command. The vcpkg-action step must have the id vcpkg.

Another directory named vcpkg_cache is created in the temp directory. This directory is used to store the cache files, and is cached using actions/cache@v4. The cache key is automatically generated, but can also be modified using the cache-key argument.

Simple usage example:

- name: vcpkg build
  uses: johnwason/vcpkg-action@v8
  id: vcpkg
  with:
    pkgs: boost-date-time boost-system
    triplet: x64-windows-release
    token: ${{ github.token }}

Simple manifest example:

- name: vcpkg build
  id: vcpkg
  uses: johnwason/vcpkg-action@v8
  with:
    manifest-dir: ${{ github.workspace }} # Set to directory containing vcpkg.json
    triplet: x64-windows-release
    token: ${{ github.token }}

Usage

- uses: johnwason/vcpkg-action@v8
  with:
    # The vcpkg packages to build, separated by spaces. Cannot be used with manifest-dir
    pkgs: ''
    # The vcpkg target triplet to use. This must be set. For windows, 
    # x64-windows-release is recommended if you don't need debug libraries
    triplet: ''
    # Extra arguments to pass to vcpkg command (optional)
    extra-args: ''
    # Additional string to add to cache key. If using a build matrix or building different configurations
    # on the same operating system, be sure to include an additional cache key to separate the caches. (optional)
    cache-key: ''
    # vcpkg revision to checkout
    # A valid git ref; if empty, it defaults to the latest vcpkg stable release.
    revision: ''
    # GitHub token to authenticate API requests. This is necessary to determine vcpkg version to checkout
    # Recommended to use ${{ github.token }}
    token: ''
    # Directory containing vcpkg.json manifest file. Cannot be used with pkgs.
    manifest-dir: ''
    #Fetch depth for vcpkg checkout. Defaults to "1"
    fetch-depth: '1'
    # Collect logs. Can be set to "always", "on-failure", or "never". Defaults to "" for "never".
    collect-logs: ''
    # a subdirectory of the action base folder into which the VCPKG will be installed. Default is 'vcpkg'.
    vcpkg-subdir: 'vcpkg'

Advanced Example

The following is an advanced example with a matrix build. Note that the runner name is included as an additional cache key.

jobs:
  buildme:
    runs-on: ${{ matrix.config.os }}
    strategy:
      matrix:
        config:
        - os: ubuntu-22.04
          vcpkg_triplet: x64-linux-release
        - os: macos-13
          vcpkg_triplet: x64-osx-release
        - os: windows-2022
          vcpkg_triplet: x64-windows-release
    steps:
      - name: vcpkg build
        uses: johnwason/vcpkg-action@v8
        id: vcpkg
        with:
          pkgs: boost-date-time
          triplet: ${{ matrix.config.vcpkg_triplet }}
          cache-key: ${{ matrix.config.os }}
          revision: master
          token: ${{ github.token }}

Hints

• Use the --x-feature=... option with extra-args to enable manifest mode features.
• Use the --x-buildtrees-root=... option with extra-args to move the build trees out of the github workspace if path length errors occur.
• Use the --clean-after-build option with extra-args to reduce disk space usage for large projects.

When using manifest mode, it is recommended to check out your source to a subdirectory to prevent vcpkg from detecting your vcpkg.json file. This action overrides the default behavior to provide caching. For example:

  - uses: actions/checkout@v6
    with:
      path: my_src