Skip to content

Commit

Permalink
add a note about requiring most recent vcpkg
Browse files Browse the repository at this point in the history
  • Loading branch information
lukka committed Mar 31, 2023
1 parent 0b4750d commit 8534542
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Coverage Status](https://coveralls.io/repos/github/lukka/run-vcpkg/badge.svg?branch=main)](https://coveralls.io/github/lukka/run-vcpkg?branch=main)

- [**It requires vcpkg more recent than 2023-03-29 (e.g. than commit id 5b1214315250939257ef5d62ecdcbca18cf4fb1c)**](#it-requires-vcpkg-more-recent-than-2023-03-29-eg-than-commit-id-5b1214315250939257ef5d62ecdcbca18cf4fb1c)
- [Quickstart with a C++ project template](#quickstart-with-a-c-project-template)
- [The **run-vcpkg@v11** action for caching artifacts and using vcpkg with manifest files on GitHub workflows](#the-run-vcpkgv11-action-for-caching-artifacts-and-using-vcpkg-with-manifest-files-on-github-workflows)
- [Quickstart with instructions](#quickstart-with-instructions)
Expand All @@ -16,6 +17,8 @@
- [Disclaimer](#disclaimer)
- [Contributing](#contributing)

# **It requires vcpkg more recent than 2023-03-29 (e.g. than commit id 5b1214315250939257ef5d62ecdcbca18cf4fb1c)**

# Quickstart with a C++ project template

Take a look at this [C++ project template](https://github.com/lukka/CppCMakeVcpkgTemplate) 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.
Expand Down Expand Up @@ -84,7 +87,7 @@ jobs:
# runVcpkgInstall: true

- name: Run CMake consuming CMakePreset.json and run vcpkg to build dependencies
uses: lukka/run-cmake@v11
uses: lukka/run-cmake@v10
with:
# This is the default path to the CMakeLists.txt along side the
# CMakePresets.json. Change if you need have CMakeLists.txt and CMakePresets.json
Expand Down Expand Up @@ -126,11 +129,9 @@ Flowchart with related input in [action.yml](https://github.com/lukka/run-vcpkg/
└─────────────┬────────────┘
┌─────────────────────────┐
│ Locate vcpkg.json. │ Inputs:
│ │ - `vcpkgJsonGlob`
│ │ - `vcpkgJsonIgnores`
└────────────┬────────────┘
┌─────────────────────────┐ Inputs:
│ Locate vcpkg.json. │ - `vcpkgJsonGlob`
└────────────┬────────────┘ - `vcpkgJsonIgnores`
┌─────────────────────────┐ Inputs:
Expand Down Expand Up @@ -211,10 +212,10 @@ _Checkmarks_ indicates whether the samples "uses" or specifies the thing in the

| workflow link | `vcpkg` as submodule | explicit triplet | `vcpkg` toolchain | `CMake`'s Presets | `Ninja` | `run-vcpkg` runs vcpkg | `CMake` runs `vcpkg` |
| :------------------------------------------------------------------------------------------------------------------------- | :------------------: | :--------------: | :---------------: | :---------------: | :-----: | :--------------------: | :------------------: |
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v11/.github/workflows/hosted-ninja-vcpkg_submod.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v11/.github/workflows/hosted-ninja-vcpkg.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v11/.github/workflows/hosted-ninja-vcpkg-install.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v11/.github/workflows/hosted-ninja-vcpkg_submod-triplet.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v10/.github/workflows/hosted-ninja-vcpkg_submod.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v10/.github/workflows/hosted-ninja-vcpkg.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v10/.github/workflows/hosted-ninja-vcpkg-install.yml) ||||||||
| [link](https://github.com/lukka/CppBuildTasks-Validation/blob/v10/.github/workflows/hosted-ninja-vcpkg_submod-triplet.yml) ||||||||

<br>

Expand Down

0 comments on commit 8534542

Please sign in to comment.