Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[vcpkg-docs] Add note about GitHub hosted agents #13641

Merged
merged 2 commits into from
Sep 28, 2020
Merged

[vcpkg-docs] Add note about GitHub hosted agents #13641

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bbbd4c
[vcpkg_docs] Add note about GitHub hosted agents
ras0219-msft Sep 21, 2020
bab8472
[vcpkg-docs] Add ./ prefixes to GitHub example
ras0219-msft Sep 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/users/binarycaching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
Expand All @@ -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
Expand All @@ -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.
Expand Down