Skip to content

Commit

Permalink
Add clarification about vcpkgJsonGlob
Browse files Browse the repository at this point in the history
  • Loading branch information
lukka committed Jul 13, 2022
1 parent 44ceef2 commit 23dce17
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ jobs:

# This is the glob expression used to locate the vcpkg.json and add its
# hash to the cache key. Change it to match a single manifest file you want
# to use.
# to use.
# Note: do not use `${{ github.context }}` to compose the value as it
# contains backslashes that would be misinterpreted. Instead
# compose a value relative to the root of the repository using
# `**/path/from/root/of/repo/to/vcpkg.json` to match the desired `vcpkg.json`.
# vcpkgJsonGlob: '**/vcpkg.json'

# This is needed to run `vcpkg install` command (after vcpkg is built) in
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ inputs:
vcpkgJsonGlob:
default: '**/vcpkg.json'
required: false
description: "Specify the glob expression used to discover the vcpkg.json whose content's hash is added to the cache key."
description: "Specify the glob expression used to discover the vcpkg.json whose content's hash is added to the cache key. On Windows runners using `github.workspace` context to form the expression would not work as expected since it contains backslashes. Use instead `**/path/to/vcpkg.json` to match the desired `vcpkg.json` file."
vcpkgJsonIgnores:
default: "['**/vcpkg/**']"
required: false
Expand Down

0 comments on commit 23dce17

Please sign in to comment.