aboutsummaryrefslogtreecommitdiff
path: root/docs/users/binarycaching.md
diff options
context:
space:
mode:
authorras0219 <533828+ras0219@users.noreply.github.com>2020-09-27 17:52:09 -0700
committerGitHub <noreply@github.com>2020-09-27 17:52:09 -0700
commitc98fd09290e1dc76c51b6599873a14703d37fc93 (patch)
tree317fa81671d13505e3afdb2bd3eabaa340f3509f /docs/users/binarycaching.md
parent794f4c0a5a65bafbb1952dfb4ac32d3ba7fe225a (diff)
downloadvcpkg-c98fd09290e1dc76c51b6599873a14703d37fc93.tar.gz
vcpkg-c98fd09290e1dc76c51b6599873a14703d37fc93.zip
[vcpkg-docs] Add note about GitHub hosted agents (#13641)
* [vcpkg_docs] Add note about GitHub hosted agents * [vcpkg-docs] Add ./ prefixes to GitHub example Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
Diffstat (limited to 'docs/users/binarycaching.md')
-rw-r--r--docs/users/binarycaching.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/users/binarycaching.md b/docs/users/binarycaching.md
index 8feef1b33..3798fbde7 100644
--- a/docs/users/binarycaching.md
+++ b/docs/users/binarycaching.md
@@ -14,6 +14,10 @@ If your CI system of choice is not listed, we welcome PRs to add them!
To use vcpkg with GitHub Packages, we recommend using the `NuGet` backend.
+>**NOTE 2020-09-21**: GitHub's hosted agents come with an older, pre-installed copy of vcpkg on the path that does not support the latest binary caching. This means that direct calls to `bootstrap-vcpkg` or `vcpkg` without a path prefix may call an unintended vcpkg instance. We recommend taking the following two steps to avoid issues if you want to use your own copy of vcpkg:
+> 1. Run the equivalent of `rm -rf "$VCPKG_INSTALLATION_ROOT"` using `shell: 'bash'`
+> 2. Always call `vcpkg` and `bootstrap-vcpkg` with a path prefix, such as `./vcpkg`, `vcpkg/vcpkg`, `.\bootstrap-vcpkg.bat`, etc
+
```yaml
# actions.yaml
#
@@ -38,7 +42,7 @@ steps:
shell: 'bash'
# Replace <OWNER> with your organization name
run: >
- ${{ matrix.mono }} `vcpkg/vcpkg fetch nuget | tail -n 1`
+ ${{ matrix.mono }} `./vcpkg/vcpkg fetch nuget | tail -n 1`
sources add
-source "https://nuget.pkg.github.com/<OWNER>/index.json"
-storepasswordincleartext
@@ -50,7 +54,7 @@ steps:
- name: 'vcpkg package restore'
shell: 'bash'
run: >
- vcpkg/vcpkg install sqlite3 cpprestsdk --triplet ${{ matrix.triplet }}
+ ./vcpkg/vcpkg install sqlite3 cpprestsdk --triplet ${{ matrix.triplet }}
```
If you're using [manifests](../specifications/manifests.md), you can omit the `vcpkg package restore` step: it will be run automatically as part of your build.