İkili önbelleğe alma yapılandırması

Yapılandırma Söz Dizimi

İkili önbelleğe alma, ortam değişkeni VCPKG_BINARY_SOURCES (olarak <source>;<source>;...ayarlanır) ve komut satırı seçeneğiyle --binarysource=<source>yapılandırılır. Seçenekler önce ortamdan, ardından komut satırından değerlendirilir. İkili önbelleğe alma, son komut satırı seçeneği olarak geçirilerek --binarysource=clear tamamen devre dışı bırakılabilir.

<rw> Belirli kaynaklar için isteğe bağlı parametre, ikili dosyaları indirme ()(readvarsayılan), isteğe bağlı derlemelerin bu uzak sürüme () veya her ikisine de (write) yüklenip yüklenmeyeceğini denetlerreadwrite.

Sağlayıcılar

AWS S3 sağlayıcısı

x-aws,<prefix>[,<rw>]

AWS CLI kullanarak bir AWS S3 kaynağı ekleyin. <ön ek> ile s3:// başlamalıdır ve ile /bitmelidir.

x-aws-config,no-sign-request

AWS CLI'ya geçin --no-sign-request .

Azure Blob Depolama sağlayıcısı

x-azblob,<baseuri>,<sas>[,<rw>]

Paylaşılan Erişim İmzası doğrulamayı kullanarak bir Azure Blob Depolama sağlayıcısı ekler. <baseuri> kapsayıcı yolunu içermelidir.

Hızlı Başlangıç

İlk olarak, bir Azure Depolama Hesabı ve bir kapsayıcı oluşturmanız gerekir. Yönergeler için Bkz. Azure Depolama Hızlı Başlangıç Belgeleri.

Ardından, Ayarlar ->Paylaşılan Erişim İmzası altındaki depolama hesabından yapılabilen bir Paylaşılan Erişim İmzası (SAS) oluşturmanız gerekir. Bu SAS için gerekenler:

• İzin verilen hizmetler: Blob
• İzin verilen kaynak türleri: Nesne
• İzin verilen izinler: Okuma (kullanıyorsanızread) veya Okuma, Oluşturma (veya readwritekullanıyorsanızwrite)

Blob uç noktası artı kapsayıcı olarak <baseuri> geçirilmelidir ve öneki olmadan ? oluşturulan SAS olarak geçirilmelidir <sas>.

Örnek:

x-azblob,https://<storagename>.blob.core.windows.net/<containername>,sv=2019-12-12&ss=b&srt=o&sp=rcx&se=2020-12-31T06:20:36Z&st=2020-12-30T22:20:36Z&spr=https&sig=abcd,readwrite

Ancak vcpkg, normal işlemler sırasında SAS'nin ortaya çıkarılmasını önlemeye çalışır:

1. Geçirilirse --debug tam olarak yazdırılır
2. Alt işlemlere bir komut satırı parametresi olarak geçirilir, örneğin curl.exe

Azure Blob Depolama, belirli sayıda gün içinde erişilmeyen önbellek girdilerini kaldırmaya yönelik bir özellik içerir ve ikili önbelleğinizin boyutunu otomatik olarak yönetmek için kullanılabilir. Daha fazla bilgi için bkz . Microsoft Docs'ta Veri Yaşam Döngüsü Yönetimi veya depolama hesabınız için Azure Portal'da Veri yönetimi ->Yaşam döngüsü yönetimi'ni arayın.

Tencent Bulut Nesne Depolama sağlayıcısı

x-cos,<prefix>[,<rw>]

BIR COS kaynağı ekler. <prefix> ile cos:// başlamalı ve ile /bitmelidir.

Dosya sağlayıcısı

files,<absolute path>[,<rw>]

Zip ile sıkıştırılmış arşivleri ikili önbelleğe alma kimliğine göre yolda depolar.

Google Cloud Storage sağlayıcısı

x-gcs,<prefix>[,<rw>]

Google Cloud Storage sağlayıcısı ekler. <prefix> ile gs:// başlamalı ve ile /bitmelidir.

Hızlı Başlangıç

İlk olarak, bir Google Cloud Platform Hesabı ve bir depolama demeti (GCS Hızlı Başlangıç] oluşturmanız gerekir.

Bu hızlı başlangıcın bir parçası olarak komut satırı aracını Google Cloud ile kimlik doğrulaması yapacak şekilde yapılandırmış gsutil olursunuz. vcpkg bu komut satırı aracını kullanır, bu nedenle yürütülebilir dosyalar için arama yolunuzda olduğundan emin olun.

Örnek 1 (nesneler için ortak ön ek olmadan bir demet kullanma):

x-gcs,gs://<bucket-name>/,readwrite

Örnek 2 (nesneler için bir demet ve ön ek kullanarak):

x-gcs,gs://<bucket-name>/my-vcpkg-cache/maybe/with/many/slashes/,readwrite
x-gcs,gs://<bucket-name>/my-vcpkg-cache/maybe/with`,commas/too!/,readwrite

Virgüller (,), GCS'deki nesne ön ekinin bir parçası olarak geçerlidir. Önceki örnekte gösterildiği gibi vcpkg yapılandırmasında bunları kaçış unutmayın. GCS'de klasörler yoktur (GCS araçlarından bazıları klasörlerin benzetimini yapar). vcpkg önbelleğiniz tarafından kullanılan ön eki oluşturmanız veya başka bir şekilde değiştirmeniz gerekmez.

GitHub Actions önbelleği

x-gha[,<rw>]

GitHub Actions önbelleğini sağlayıcı olarak ekler. Bu ikili önbelleğe alma sağlayıcısı yalnızca GitHub Actions iş akışı bağlamında geçerlidir. Bu sağlayıcı hem hem de ACTIONS_CACHE_URL ACTIONS_RUNTIME_TOKEN ortam değişkenlerinin ayarlanmasını gerektirir. Bu ortam değişkenlerini doğru ayarlamak, aşağıdaki Hızlı Başlangıç bölümünde ele alınmıştır.

Hızlı Başlangıç

vcpkg'nin GitHub Actions Önbelleği'ni kullanabilmesi için Eylemler Önbelleği URL'si ve Çalışma Zamanı Belirteci gerekir. Bunu yapmak için her iki değer de aşağıdakine benzer bir iş akışı adımında ortam değişkenleri olarak dışarı aktarılmalıdır:

- uses: actions/github-script@v7
  with:
    script: |
      core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
      core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');

GitHub Actions Önbelleği ikili önbelleğe alma sağlayıcısı yalnızca GitHub Actions iş akışından kullanılabildiği için bu değerleri vcpkg komut satırı bağımsız değişkenleri yerine ortam değişkenleri olarak belirtmek tasarım gereğidir.

Ortam değişkenleri dışarı aktarıldıktan sonra vcpkg, GitHub Actions ikili önbelleğe alma sağlayıcısıyla aşağıdaki gibi çalıştırılabilir:

- name: Install dependencies via vcpkg
  run: vcpkg install zlib --binarysource="clear;x-gha,readwrite"

Azure Artifacts'te Evrensel Paketler

x-az-universal,<organization>,<project>,<feed>[,<rw>]

Azure Artifacts'e Evrensel Paketler'i sağlayıcı olarak ekler.

Hızlı Başlangıç

İlk olarak, Evrensel Paketler akışı oluşturmanız gerekir. Yönergeler için Evrensel Paketler hızlı başlangıcına bakın.

Ardından Azure CLI'yı yüklemeniz ve kimlik doğrulaması yapmanız gerekir. Yönergeler için Azure CLI kimlik doğrulaması kılavuzuna bakın. vcpkg bu komut satırı aracını kullanır, bu nedenle yürütülebilir dosyalar için arama yolunuzda olduğundan emin olun.

Örnek:

x-az-universal,organization_url,project_name,feed_name,readwrite

project_name Vcpkg'nin bir proje kapsamında evrensel paketleri indirmesini ve akışınızda yayımlamasını sağlamak için parametresini sağlayın.

x-az-universal,organization_url,,feed_name,readwrite

project_name Vcpkg'nin kuruluş kapsamında evrensel paketleri indirip akışınızda yayımlamasını sağlamak için parametresini boş bırakın.

HTTP sağlayıcısı

http,<url_template>[,<rw>[,<header>]]

Her ikili önbelleğe alma işlemi bir HTTP fiiline eşlenir:

• İndirmek- GET
• Karşıya yükleme- PUT
• Varlığı Denetle - HEAD

URL Şablonu

Şablon, değişken genişletme için küme ayraçlarını kullanır. 'name', 'version', 'sha' ve 'triplet' değişkenlerini kullanabilirsiniz. Örneğin:

https://cache.example.com/{name}/{version}/{sha}

Üst bilgi

Kimlik doğrulaması, bir HTTP Yetkilendirme Üst Bilgisi belirtilerek desteklenir. Örneğin:

http,https://cache.example.com/{name}/{version}/{sha},readwrite,Authorization: Bearer BearerTokenValue

NuGet sağlayıcısı

NuGet CLI parametresiyle -Source bir NuGet sunucusu ekleyin:

nuget,<uri>[,<rw>]

NuGet CLI parametresiyle -Config bir NuGet yapılandırma dosyası kullanın:

nugetconfig,<path>[,<rw>]

NuGet kaynakları için zaman aşımını yapılandırın:

nugettimeout,<seconds>

Yapılandırma dosyaları, paketlerin akışa geri yazılabilmesini desteklemek için bir defaultPushSource tanımlamalıdır.

Referans

Birçok NuGet sunucusuna erişmek için ek kimlik bilgileri gerekir. Kimlik bilgilerini sağlamanın en esnek yolu, kaynak üzerinden nugetconfig özel nuget.config bir dosya kullanmaktır. Daha fazla bilgi için bkz . Kimliği doğrulanmış akışlardan paketleri kullanma.

Ancak, NuGet'in yerleşik kimlik bilgisi sağlayıcılarını kullanarak veya ortamınızın varsayılanını nuget.configözelleştirerek birçok sunucuda kimlik doğrulaması yapmak mümkündür. Varsayılan yapılandırma, aşağıdaki gibi nuget istemci çağrıları aracılığıyla genişletilebilir:

nuget sources add -Name MyRemote -Source https://... -Username $user -Password $pass

ve ardından aracılığıyla nuget,MyRemote,readwritevcpkg'ye geçirildi. komutunu çalıştırarak vcpkg fetch nugetvcpkg tarafından kullanılan NuGet'in tam kopyasının yolunu alabilirsiniz. Bu, aşağıdakine benzer bir rapor sunar:

$ vcpkg fetch nuget
/vcpkg/downloads/tools/nuget-5.5.1-linux/nuget.exe

Windows olmayan kullanıcıların bunu aracılığıyla mono olarak mono /path/to/nuget.exe sources add ...çağırması gerekir.

metadata.repository

nuget ve nugetconfig kaynak sağlayıcıları, nuget paketleri oluştururken belirli ortam değişkenlerine saygı gösterir. metadata.repository Herhangi bir paketin alanı şu şekilde oluşturulur:

    <repository type="git" url="${VCPKG_NUGET_REPOSITORY}"/>

veya

    <repository type="git"
                url="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git"
                branch="${GITHUB_REF}"
                commit="${GITHUB_SHA}"/>

uygun ortam değişkenleri tanımlanmışsa ve boş değilse. Bu özellikle GitHub Packages içindeki paketleri derleme projesiyle ilişkilendirmek için kullanılır ve özgün paket kaynaklarıyla ilişkilendirmek için tasarlanmamıştır.

NuGet Önbelleği

NuGet'in kullanıcı genelindeki önbelleği varsayılan olarak kullanılmaz. Bunu her nuget tabanlı kaynakta kullanmak için ortam değişkenini trueVCPKG_USE_NUGET_CACHE (büyük/küçük harfe duyarsız) veya 1olarak ayarlayın.

Sağlayıcı Örnekleri

Tercih ettiğiniz CI sistemi listede yoksa, eklemek için bir ÇEKME isteği gönderebilirsiniz!

GitHub Paketleri

GitHub Packages ile vcpkg kullanmak için NuGet sağlayıcısının kullanılması önerilir.

# actions.yaml
#
# In this example, vcpkg has been added as a submodule (`git submodule add https://github.com/Microsoft/vcpkg`).
env:
  VCPKG_BINARY_SOURCES: 'clear;nuget,GitHub,readwrite'

matrix:
  os: ['windows-2019', 'ubuntu-20.04']
  include:
    - os: 'windows-2019'
      triplet: 'x86-windows'
      mono: ''
    - os: 'ubuntu-20.04'
      triplet: 'x64-linux'
      # To run `nuget.exe` on non-Windows platforms, `mono` must be used.
      mono: 'mono'

steps:
  # This step assumes `vcpkg` has been bootstrapped (run `./vcpkg/bootstrap-vcpkg`)
  - name: 'Setup NuGet Credentials'
    shell: 'bash'
    # Replace <OWNER> with your organization name
    run: |
      ${{ matrix.mono }} `./vcpkg/vcpkg fetch nuget | tail -n 1` \
        sources add \
        -source "https://nuget.pkg.github.com/<OWNER>/index.json" \
        -storepasswordincleartext \
        -name "GitHub" \
        -username "<OWNER>" \
        -password "${{ secrets.GITHUB_TOKEN }}"
      ${{ matrix.mono }} `./vcpkg/vcpkg fetch nuget | tail -n 1` \
        setapikey "${{ secrets.GITHUB_TOKEN }}" \
        -source "https://nuget.pkg.github.com/<OWNER>/index.json"

  # Omit this step if you're using manifests
  - name: 'vcpkg package restore'
    shell: 'bash'
    run: >
      ./vcpkg/vcpkg install sqlite3 cpprestsdk --triplet ${{ matrix.triplet }}

Bildirimleri kullanıyorsanız adımı atlayabilirsinizvcpkg package restore: derlemenizin bir parçası olarak otomatik olarak çalıştırılır.

Daha fazla bilgi için GitHub Packages'ın NuGet belgelerine bakın.

Azure DevOps Yapıtları

Azure DevOps Artifacts ile vcpkg kullanmak için NuGet sağlayıcısının kullanılması önerilir.

İlk olarak, DevOps hesabınızda Artifacts'in etkinleştirildiğinden emin olun. Yönetici bunu Proje Ayarları -Genel ->>Genel Bakış ->Azure DevOps Services>Yapıtları aracılığıyla etkinleştirebilir.

Ardından, projeniz için bir akış oluşturun. Akış URL'niz ile /nuget/v3/index.jsonbiten bir https:// bağlantı olacaktır. Daha fazla bilgi için Bkz . Azure DevOps Artifacts Belgeleri.

bir işlem hattından akışı kullanma

# azure-pipelines.yaml
variables:
- name: VCPKG_BINARY_SOURCES
  value: 'clear;nuget,<FEED_URL>,readwrite'

steps:
# Remember to add this task to allow vcpkg to upload archives via NuGet
- task: NuGetAuthenticate@0

Windows dışı bir işletim sistemi ile özel aracılar kullanıyorsanız, (, vbbrew install mono.) çalıştırmak nuget.exeapt install mono-completeiçin Mono yüklemeniz gerekir.

Akışı yerel olarak kullanma

# On Windows Powershell
PS> & $(vcpkg fetch nuget | select -last 1) sources add `
  -name ADO `
  -Source https://pkgs.dev.azure.com/$ORG/_packaging/$FEEDNAME/nuget/v3/index.json `
  -Username $USERNAME `
  -Password $PAT
PS> $env:VCPKG_BINARY_SOURCES="nuget,ADO,readwrite"

# On Linux or OSX
$ mono `vcpkg fetch nuget | tail -n1` sources add \
  -name ADO \
  -Source https://pkgs.dev.azure.com/$ORG/_packaging/$FEEDNAME/nuget/v3/index.json \
  -Username $USERNAME \
  -Password $PAT
$ export VCPKG_BINARY_SOURCES="nuget,ADO,readwrite"

Maksimum güvenlik için parola olarak Kişisel Erişim Belirteci (PAT) kullanın. Kullanıcı Ayarları ->Kişisel Erişim Belirteçleri veya https://dev.azure.com/<ORG>/_usersSettings/tokensiçinde bir PAT oluşturabilirsiniz.

ABI Karması

Vcpkg, her derleme için denkliği belirlemek için bir ABI Karması hesaplar. İki derleme aynı ABI Karması'na sahipse, vcpkg bunları aynı kabul eder ve ikili dosyaları projeler ve makineler arasında yeniden kullanabilir.

ABI Karması aşağıdakileri dikkate alır:

• Bağlantı noktası dizinindeki her dosya
• Üçlü dosya içeriği ve adı
• C++ derleyici yürütülebilir dosyası
• C derleyici yürütülebilir dosyası
• Seçilen özellik kümesi
• Her bağımlılığın ABI Karması
• (Buluşsal) tarafından portfile.cmake başvurulmuş tüm yardımcı işlevler
• Kullanılan CMake sürümü
• içinde listelenen ortam değişkenlerinin içeriği VCPKG_ENV_PASSTHROUGH
• Araç zinciri dosyasının metin içeriği (VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
• GRDK araç seti (yalnızca Xbox platformunu hedeflerken)

Bu kapsamlı listeye rağmen, önbelleği yenmek ve belirsizliği tanıtmak mümkündür. Ortamınız için izlemeniz gereken ek ayrıntılarınız varsa, ek bilgilerinizi bir yorumda içeren bir üçlü dosya oluşturabilirsiniz. Bu ek bilgiler ABI Karması'na dahil edilecek ve benzersiz bir ikililer evrenini güvence altına alacaktır.

adlı .DS_Store dosyalar ABI karması için dikkate alınmaz.

Hesaplanan ABI Karmaları her pakette ve denetim için konumundaki geçerli yüklü dizinde /share/<port>/vcpkg_abi_info.txt depolanır.

Zlib'in ABI Karması Örneği

Bir pacakge'nin tam Uygulama İkili Arabirimi (ABI) karmasını yazdırmak için hata ayıklama çıktısını etkinleştirin. Zlib için:

[DEBUG] Trying to hash <path>\buildtrees\zlib\x86-windows.vcpkg_abi_info.txt
[DEBUG] <path>\buildtrees\zlib\x86-windows.vcpkg_abi_info.txt has hash bb1c96759ac96102b4b18215db138daedd3eb16c2cd3302ae7bffab2b643eb87

Paket zlib için ABI karmasıbb1c96759ac96102b4b18215db138daedd3eb16c2cd3302ae7bffab2b643eb87, ikili paketleri ayırt etmek için tüm olası ilgili bilgiler karma olarak oluşturulur.

Derleyicinizin sürümü ABI karması kapsamındadır ve aşağıda hesaplanır:

[DEBUG] -- The C compiler identification is MSVC 19.36.32538.0
[DEBUG] -- The CXX compiler identification is MSVC 19.36.32538.0
[DEBUG] #COMPILER_HASH#f5d02a6542664cfbd4a38db478133cbb1a18f315

İlgili dosyalar, derleyici ve araç sürümü bilgileri, son ABI karması hesaplamak için karma olarak oluşturulur:

[DEBUG] <abientries for zlib:x86-windows>
[DEBUG]   0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch|750b9542cb55e6328cca01d3ca997f1373b9530afa95e04213168676936e7bfa
[DEBUG]   0002-skip-building-examples.patch|835ddecfed752e0f49be9b0f8ff7ba76541cb0a150044327316e22ca84f8d0c2
[DEBUG]   0003-build-static-or-shared-not-both.patch|d6026271dcb3d8fc74b41e235620ae31576a798e77aa411c3af8cd9e948c02b1
[DEBUG]   0004-android-and-mingw-fixes.patch|37a43eddbcb1b7dde49e7659ae895dfd0ff1df66666c1371ba7d5bfc49d8b438
[DEBUG]   cmake|3.26.2
[DEBUG]   features|core
[DEBUG]   portfile.cmake|ac63047b644fa758860dd7ba48ff9a13b058c6f240b8e8d675b8fbba035976be
[DEBUG]   ports.cmake|5a8e00cedff0c898b1f90f7d129329d0288801bc9056562b039698caf31ff3f3
[DEBUG]   post_build_checks|2
[DEBUG]   powershell|7.3.6
[DEBUG]   triplet|x86-windows
[DEBUG]   triplet_abi|3e71dd1d4afa622894ae367adbbb1ecbd42c57c51428a86b675fa1c8cad3a581-36b818778ba6f2c16962495caedb9a7b221d5be4c60de1cd3060f549319a9931-f5d02a6542664cfbd4a38db478133cbb1a18f315
[DEBUG]   usage|be22662327df993eebc437495add75acb365ab18d37c7e5de735d4ea4f5d3083
[DEBUG]   vcpkg-cmake|1b3dac4b9b0bcbef227c954b495174863feebe3900b2a6bdef0cd1cf04ca1213
[DEBUG]   vcpkg-cmake-wrapper.cmake|5d49ef2ee6448479c2aad0e5f732e2676eaba0411860f9bebabe6002d66f57d1
[DEBUG]   vcpkg.json|bc94e2540efabe36130a806381a001c57194e7de67454ab7ff1e30aa15e6ce23
[DEBUG]   vcpkg_copy_pdbs|d57e4f196c82dc562a9968c6155073094513c31e2de475694143d3aa47954b1c
[DEBUG]   vcpkg_fixup_pkgconfig|588d833ff057d3ca99c14616c7ecfb5948b5e2a9e4fc02517dceb8b803473457
[DEBUG]   vcpkg_from_git|8f27bff0d01c6d15a3e691758df52bfbb0b1b929da45c4ebba02ef76b54b1881
[DEBUG]   vcpkg_from_github|b743742296a114ea1b18ae99672e02f142c4eb2bef7f57d36c038bedbfb0502f
[DEBUG]   vcpkg_replace_string|d43c8699ce27e25d47367c970d1c546f6bc36b6df8fb0be0c3986eb5830bd4f1
[DEBUG] </abientries>