aboutsummaryrefslogtreecommitdiff
path: root/vcpkg/scripts/cmake/vcpkg_from_github.cmake
diff options
context:
space:
mode:
authorEthan Morgan <ethan@gweithio.com>2026-02-14 16:44:06 +0000
committerEthan Morgan <ethan@gweithio.com>2026-02-14 16:44:06 +0000
commit54409423f767d8b1cf30cb7d0efca6b4ca138823 (patch)
treed915ac7828703ce4b963efdd9728a1777ba18c1e /vcpkg/scripts/cmake/vcpkg_from_github.cmake
move to own git serverHEADmaster
Diffstat (limited to 'vcpkg/scripts/cmake/vcpkg_from_github.cmake')
-rw-r--r--vcpkg/scripts/cmake/vcpkg_from_github.cmake136
1 files changed, 136 insertions, 0 deletions
diff --git a/vcpkg/scripts/cmake/vcpkg_from_github.cmake b/vcpkg/scripts/cmake/vcpkg_from_github.cmake
new file mode 100644
index 0000000..5e5c2c1
--- /dev/null
+++ b/vcpkg/scripts/cmake/vcpkg_from_github.cmake
@@ -0,0 +1,136 @@
+function(vcpkg_from_github)
+ cmake_parse_arguments(PARSE_ARGV 0 "arg"
+ "USE_TARBALL_API"
+ "OUT_SOURCE_PATH;REPO;REF;SHA512;HEAD_REF;GITHUB_HOST;AUTHORIZATION_TOKEN;FILE_DISAMBIGUATOR"
+ "PATCHES")
+
+ if(DEFINED arg_UNPARSED_ARGUMENTS)
+ message(WARNING "vcpkg_from_github was passed extra arguments: ${arg_UNPARSED_ARGUMENTS}")
+ endif()
+
+ if(DEFINED arg_REF AND NOT DEFINED arg_SHA512)
+ message(FATAL_ERROR "SHA512 must be specified if REF is specified.")
+ endif()
+ if(NOT DEFINED arg_REF AND DEFINED arg_SHA512)
+ message(FATAL_ERROR "REF must be specified if SHA512 is specified.")
+ endif()
+
+ if(NOT DEFINED arg_OUT_SOURCE_PATH)
+ message(FATAL_ERROR "OUT_SOURCE_PATH must be specified.")
+ endif()
+ if(NOT DEFINED arg_REPO)
+ message(FATAL_ERROR "The GitHub repository must be specified.")
+ endif()
+
+ if(NOT DEFINED arg_GITHUB_HOST)
+ set(github_host "https://github.com")
+ set(github_api_url "https://api.github.com")
+ else()
+ set(github_host "${arg_GITHUB_HOST}")
+ set(github_api_url "${arg_GITHUB_HOST}/api/v3")
+ endif()
+
+ set(headers_param "")
+ if(DEFINED arg_AUTHORIZATION_TOKEN)
+ set(headers_param "HEADERS" "Authorization: token ${arg_AUTHORIZATION_TOKEN}")
+ endif()
+
+
+ if(NOT DEFINED arg_REF AND NOT DEFINED arg_HEAD_REF)
+ message(FATAL_ERROR "At least one of REF or HEAD_REF must be specified.")
+ endif()
+
+ if(NOT arg_REPO MATCHES "^([^/]*)/([^/]*)$")
+ message(FATAL_ERROR "REPO (${arg_REPO}) is not a valid repo name:
+ must be an organization name followed by a repository name separated by a single slash.")
+ endif()
+ set(org_name "${CMAKE_MATCH_1}")
+ set(repo_name "${CMAKE_MATCH_2}")
+
+ if(VCPKG_USE_HEAD_VERSION AND NOT DEFINED arg_HEAD_REF)
+ message(STATUS "Package does not specify HEAD_REF. Falling back to non-HEAD version.")
+ set(VCPKG_USE_HEAD_VERSION OFF)
+ elseif(NOT VCPKG_USE_HEAD_VERSION AND NOT DEFINED arg_REF)
+ message(FATAL_ERROR "Package does not specify REF. It must be built using --head.")
+ endif()
+
+ # exports VCPKG_HEAD_VERSION to the caller. This will get picked up by ports.cmake after the build.
+ if(VCPKG_USE_HEAD_VERSION)
+ string(REPLACE "/" "_-" sanitized_head_ref "${arg_HEAD_REF}")
+ vcpkg_download_distfile(archive_version
+ URLS "${github_api_url}/repos/${org_name}/${repo_name}/git/refs/heads/${arg_HEAD_REF}"
+ FILENAME "${org_name}-${repo_name}-${sanitized_head_ref}.version"
+ ${headers_param}
+ SKIP_SHA512
+ ALWAYS_REDOWNLOAD
+ )
+ # Parse the github refs response with regex.
+ file(READ "${archive_version}" version_contents)
+ string(JSON head_version
+ ERROR_VARIABLE head_version_err
+ GET "${version_contents}"
+ "object"
+ "sha"
+ )
+ if(NOT "${head_version_err}" STREQUAL "NOTFOUND")
+ message(FATAL_ERROR "Failed to parse API response from '${version_url}':
+${version_contents}
+
+Error was: ${head_version_err}
+")
+ endif()
+
+ set(VCPKG_HEAD_VERSION "${head_version}" PARENT_SCOPE)
+ set(ref_to_use "${head_version}")
+
+ vcpkg_list(SET redownload_param ALWAYS_REDOWNLOAD)
+ vcpkg_list(SET sha512_param SKIP_SHA512)
+ vcpkg_list(SET working_directory_param WORKING_DIRECTORY "${CURRENT_BUILDTREES_DIR}/src/head")
+ vcpkg_list(SET skip_patch_check_param SKIP_PATCH_CHECK)
+ else()
+ set(ref_to_use "${arg_REF}")
+
+ vcpkg_list(SET redownload_param)
+ vcpkg_list(SET working_directory_param)
+ vcpkg_list(SET skip_patch_check_param)
+ vcpkg_list(SET sha512_param SHA512 "${arg_SHA512}")
+ endif()
+
+ string(REPLACE "/" "_-" sanitized_ref "${ref_to_use}")
+ if(DEFINED arg_FILE_DISAMBIGUATOR AND NOT VCPKG_USE_HEAD_REF)
+ set(downloaded_file_name "${org_name}-${repo_name}-${sanitized_ref}-${arg_FILE_DISAMBIGUATOR}.tar.gz")
+ else()
+ set(downloaded_file_name "${org_name}-${repo_name}-${sanitized_ref}.tar.gz")
+ endif()
+
+ if(arg_USE_TARBALL_API)
+ # This alternative endpoint has a better support for GitHub's personal
+ # access tokens (for instance when there is SSO enabled within the
+ # organization).
+ set(download_url
+ "${github_api_url}/repos/${org_name}/${repo_name}/tarball/${ref_to_use}"
+ )
+ else()
+ set(download_url
+ "${github_host}/${org_name}/${repo_name}/archive/${ref_to_use}.tar.gz"
+ )
+ endif()
+
+ # Try to download the file information from github
+ vcpkg_download_distfile(archive
+ URLS "${download_url}"
+ FILENAME "${downloaded_file_name}"
+ ${headers_param}
+ ${sha512_param}
+ ${redownload_param}
+ )
+ vcpkg_extract_source_archive_ex(
+ OUT_SOURCE_PATH SOURCE_PATH
+ ARCHIVE "${archive}"
+ REF "${sanitized_ref}"
+ PATCHES ${arg_PATCHES}
+ ${working_directory_param}
+ ${skip_patch_check_param}
+ )
+ set("${arg_OUT_SOURCE_PATH}" "${SOURCE_PATH}" PARENT_SCOPE)
+endfunction()