Skip to content

[vcpkg_from_github] Document USE_TARBALL_API. #476

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

Merged
vicroms merged 2 commits into from
May 1, 2025
Merged

[vcpkg_from_github] Document USE_TARBALL_API. #476

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e677dc
[vcpkg_from_github] Document USE_TARBALL_API.
BillyONeal Apr 25, 2025
e8652e5
Fix #use_tarball_api
BillyONeal Apr 25, 2025
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
11 changes: 9 additions & 2 deletions vcpkg/maintainers/functions/vcpkg_from_github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: vcpkg_from_github
description: Learn how to use vcpkg_from_github.
ms.date: 01/10/2024
ms.date: 04/24/2025
---
# vcpkg_from_github

Expand All @@ -22,6 +22,7 @@ vcpkg_from_github(
[GITHUB_HOST <https://github.com>]
[AUTHORIZATION_TOKEN <${SECRET_FROM_FILE}>]
[FILE_DISAMBIGUATOR <N>]
[USE_TARBALL_API]
)
```

Expand Down Expand Up @@ -71,12 +72,18 @@ This field should contain the scheme, host, and port of the desired URL without

### AUTHORIZATION_TOKEN

A token to be passed via the Authorization HTTP header as "token ${AUTHORIZATION_TOKEN}".
A token to be passed via the Authorization HTTP header as "token ${AUTHORIZATION_TOKEN}". If `AUTHORIZATION_TOKEN` is a [fine-grained access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens), you must also use [`USE_TARBALL_API`](#use_tarball_api).

### FILE_DISAMBIGUATOR

A token to uniquely identify the resulting filename if the SHA512 changes even though a git ref does not, to avoid stepping on the same file name.

### USE_TARBALL_API

When specified, vcpkg will use the tarball API documented at [GitHub REST API](https://docs.github.com/rest/repos/contents?#download-a-repository-archive-tar) rather than the archive API to download sources.

This option exists rather than being a globally controlled setting because the SHA512 of sources returned by the tarball API differs from the regular archives API.

## Notes

At least one of `REF` and `HEAD_REF` must be specified, however it is preferable for both to be present.
Expand Down