12 KiB

Исходник Постоянная ссылка Ответственный История

vcpkg_tool_release_process

This document describes the acceptance criteria / process we use when doing a vcpkg-tool update, such as https://github.com/microsoft/vcpkg/pull/23757

Update $/vcpkg-init/vcpkg-scripts-sha.txt to the current master branch SHA in the registry repo.
Verify that all tests etc. are passing in the vcpkg-tool repo's main branch, and that the contents therein are acceptable for release. (Steps after this will sign code there, so this review is responsible gating what has access to code signing.)
Check that the changes there are in fact the changes that we want in that release. (Be aware, you are responsible for what is about to be signed with a Microsoft code signing certificate by proceeding)
Submit a signed build from "vcpkg Signed Binaries (from GitHub)" ( https://devdiv.visualstudio.com/DevDiv/_build?definitionId=17772&_a=summary as of this writing)
The signed build will automatically create a draft GitHub release at https://github.com/microsoft/vcpkg-tool/releases . Erase the contents filled in there and press the "auto generate release notes" button. Manually remove any entries created by the automated localization tools which will start with * LEGO: Pull request from juno/.
Publish that draft release as "pre-release".
Clean up a machine for the following tests:
- Delete VCPKG_DOWNLOADS/artifacts (which forces artifacts to be reacquired)
- Delete LOCALAPPDATA/vcpkg (which forces registries to be reacquired)
Smoke test the 'one liner' installer: (Where 2024-06-10 is replaced with the right release name)
- Powershell: iex (iwr https://github.com/microsoft/vcpkg-tool/releases/download/2024-06-10/vcpkg-init.ps1)
- Batch: curl -L -o vcpkg-init.cmd https://github.com/microsoft/vcpkg-tool/releases/download/2024-06-10/vcpkg-init.ps1 && .\vcpkg-init.cmd
- Bash: . <(curl https://github.com/microsoft/vcpkg-tool/releases/download/2024-06-10/vcpkg-init -L) (and test that vcpkg use microsoft:cmake works from each of these)
Create a new task in the DevDiv VS instance for this release. (PRs into VS Code and VS require an associated work item in order to be merged.)
In the vcpkg repo, run \scripts\update-vcpkg-tool-metadata.ps1 -Date 2024-06-10 with the new release date, which updates SHAs as appropriate. It will also emit a code block for the next vscode-embedded-tools repo step. Commit these changes and submit as a PR.
In the DevDiv vscode-embedded-tools repo, follow the update instructions to make a VS Code update PR. Don't forget to attach the work item created in the previous step. Example: https://devdiv.visualstudio.com/DefaultCollection/DevDiv/_git/vscode-embedded-tools/pullrequest/498107
If changes in this release that might affect ports, submit a new full tree rebuild by microsoft.vcpkg.ci (https://dev.azure.com/vcpkg/public/_build?definitionId=29 as of this writing) targeting refs/pull/NUMBER/head
(Probably the next day) Check over the failures and ensure any differences with the most recent full rebuild using the previous tool version are understood.
In the DevDiv VS repo ( https://devdiv.visualstudio.com/DefaultCollection/DevDiv/_git/VS ), update src\ConfigData\Packages\Redist\Setup.props
The first time you try to do a VS update on a machine, open a developer command prompt, go to src\vc\projbld\Vcpkg\VcpkgInsertionUtility, and follow the instructions to make Program.exe in a comment in Program.cs
Download the VS-insertion .nupkg.
Run src\vc\projbld\Vcpkg\VcpkgInsertionUtility\Program.exe path-to-nupkg
Go to the root of the VS repo and run init.cmd -CoreXTProfileName VSPartners
Submit this as a change to the VS repo. Example: https://devdiv.visualstudio.com/DefaultCollection/DevDiv/_git/VS/pullrequest/498110 Don't forget to attach the work item number from the previous step.
Smoke test the copy of vcpkg inserted into VS. See smoke test steps below. The prototype copy is at "CloudBuild - PR -> Extensions\VS Enterprise\Release Channel" as of 2023-10-19 but this UI changes frequently.
(After all tests have passed, at the same time) Merge all 3 PRs, and change the github release in vcpkg-tool from "prerelease" to "release". (This automatically updates the aka.ms links)
Mark any requires:vcpkg-tool-release issues as fixed by the tool release.

Release Data Flow

flowchart TD
    vcpkg_repo[(GitHub vcpkg Repo)]
    vcpkg_tool_repo[(GitHub vcpkg-tool Repo)]
    vcpkg_tool_releases[(GitHub vcpkg-tool Releases)]
    vcpkg_signed_binaries{"vcpkg Signed Binaries (from GitHub)"}
    vs_nuget_feed[(devdiv/VS NuGet Feed)]
    vs_corext_feed[(devdiv/VS-CoreXtFeeds NuGet Feed)]
    subgraph vcpkg_update_pr [vcpkg Update PR]
        direction LR
        update_vcpkg_tool_metadata_ps1[update-vcpkg-tool-metadata.ps1]
        vcpkg_tool_metadata_txt[vcpkg-tool-metadata.txt]
        vcpkg_repo_target[(GitHub vcpkg Repo)]
    end
    create_vcpkg_pr{Create GitHub vcpkg PR}
    run_full_tree_rebuild{Maybe Run Full Rebuild}
    release_version[(Version Date and SHAs)]
    subgraph vs_update_pr [Visual Studio Update PR]
        direction LR
        vs_repo[(devdiv VS Repo)]
        default_config[default.config]
        run_insertion{Run VcpkgInsertionUtility}
    end
    create_vs_pr{Create VS PR}
    smoke_test_vs{Smoke Test VS}
    merge{Merge All PRs, Make Not Prerelease, At Same Time}
    smoke_test_cmd{Smoke Test vcpkg-init.cmd}
    smoke_test_ps1{Smoke Test vcpkg-init.ps1}
    smoke_test_bash{Smoke Test vcpkg-init.sh}
    subgraph vs_code_update_pr [Visual Studio Code Update PR]
        direction LR
        package_json[(package.json)]
        changelog_md[(CHANGELOG.md)]
        vs_embedded_tools_repo[(vs_embedded_tools Repo)]
    end
    create_vs_code_update_pr{Create Visual Studio Code Update PR}
    symweb[(//symweb, etc.)]
    
    %% Build the Release
    vcpkg_tool_repo --> vcpkg_signed_binaries
    vcpkg_repo -- vcpkg-tool/vcpkg-scripts-sha.txt --> vcpkg_signed_binaries
    vcpkg_signed_binaries --> vcpkg_tool_releases
    vcpkg_signed_binaries --> release_version
    vcpkg_signed_binaries --> symweb
    
    %% vcpkg Update
    release_version --> update_vcpkg_tool_metadata_ps1
    update_vcpkg_tool_metadata_ps1 --> vcpkg_tool_metadata_txt
    vcpkg_tool_metadata_txt --> vcpkg_repo_target
    vcpkg_update_pr ----> create_vcpkg_pr
    create_vcpkg_pr --> run_full_tree_rebuild
    
    %% VS Update
    vcpkg_signed_binaries --> vs_nuget_feed
    vs_nuget_feed -- upstream --> vs_corext_feed
    vs_corext_feed --> default_config
    release_version --> default_config
    default_config --> run_insertion
    run_insertion --> vs_repo
    vs_update_pr --> create_vs_pr
    
    %% VS Code Update
    update_vcpkg_tool_metadata_ps1 --> package_json
    release_version --> changelog_md
    package_json --> vs_embedded_tools_repo
    changelog_md --> vs_embedded_tools_repo
    vs_code_update_pr --> create_vs_code_update_pr
    
    %% Smoke Testing
    create_vs_pr --> smoke_test_vs
    vcpkg_tool_releases --> smoke_test_cmd
    vcpkg_tool_releases --> smoke_test_ps1
    vcpkg_tool_releases --> smoke_test_bash
    
    %% Go go go!
    smoke_test_cmd --> merge
    smoke_test_ps1 --> merge
    smoke_test_bash --> merge
    smoke_test_vs --> merge
    run_full_tree_rebuild --> merge
    create_vs_code_update_pr --> merge

vcpkg Signed Binaries (from GitHub) Uses the azure-pipelines/signing.yml file in the vcpkg-tool repo.
devdiv/VS NuGet Feed
devdiv/VS-CoreXtFeeds NuGet Feed
devdiv VS Repo
- Run VcpkgInsertionUtility at $/src/vc/projbld/Vcpkg/VcpkgInsertionUtility/run.cmd
vscode-embedded-tools Repo
- package.json and CHANGELOG.md are in $/app/vscode-embedded-tools
Run Full Rebuild: Queue a microsoft.vcpkg.ci run for refs/pull/NUMBER/head
- Example: https://dev.azure.com/vcpkg/public/_build/results?buildId=73664&view=results

Smoke Testing VS

Install the prototype version of VS with the vcpkg inserted. Ensure the native desktop workload is selected, and that vcpkg and cmake bits are installed. Don't forget about preinstall. ( https://aka.ms/VSPreinstall ? )
Open a developer command prompt and run vcpkg integrate install (this step hopefully removed soon)
- This also verifies that vcpkg installed into the developer command prompt correctly.
Create a new C++ console project.
Turn on diagnostic logging.
- Tools -> Options: Projects and Solutions\Build and Run\MSBuild project output verbosity
Build the console project, check that vcpkg isn't affecting that project:
- Lib AdditionalLibraryDirectories doesn't contain a hypothetical vcpkg installed directory
- Target VcpkgInstallManifestDependencies doesn't run
- Target AppLocalFromInstalled doesn't run
In the developer command prompt cd to the directory with the vcxproj for the console app and run:
```
vcpkg new --application
vcpkg add port zlib
```

Rebuild the console app, and verify the manifest mode warning is printed:

1>Target "VcpkgCheckManifestRoot" in file "C:\Program Files\Microsoft Visual Studio\2022\Preview\VC\vcpkg\scripts\buildsystems\msbuild\vcpkg.targets":
1>  Task "Error" skipped, due to false condition; ('$(VcpkgEnableManifest)' == 'true' and '$(_ZVcpkgManifestRoot)' == '') was evaluated as ('false' == 'true' and 'C:\Users\bion\source\repos\ConsoleApplication3\ConsoleApplication3\' == '').
1>  Task "Message"
1>    Task Parameter:Importance=High
1>    Task Parameter:Text=The vcpkg manifest was disabled, but we found a manifest file in C:\Users\bion\source\repos\ConsoleApplication3\ConsoleApplication3\. You may want to enable vcpkg manifests in your properties page or pass /p:VcpkgEnableManifest=true to the msbuild invocation.
1>    The vcpkg manifest was disabled, but we found a manifest file in C:\Users\bion\source\repos\ConsoleApplication3\ConsoleApplication3\. You may want to enable vcpkg manifests in your properties page or pass /p:VcpkgEnableManifest=true to the msbuild invocation.
1>  Done executing task "Message".

Right click the console application, properties, and in the property pages change vcpkg\Use vcpkg Manifest to "Yes"
Rebuild the project, observe vcpkg builds zlib.

Change the .cpp to:

#include <iostream>
#include <zlib.h>

int main()
{
    std::cout << "Hello World!\n" << ZLIB_VERSION;
}

Run the program and verify that a reasonable zlib version is printed.
Close Visual Studio.

In the directory of that vcxproj, create a CMakeLists.txt with the following content:

cmake_minimum_required(VERSION 3.24)
project(console-app LANGUAGES CXX)
message(WARNING "CMake Version is ${CMAKE_VERSION}")
find_package(ZLIB REQUIRED)
file(GLOB PROGRAM_SOURCES *.cpp)
add_executable(program ${PROGRAM_SOURCES})
target_link_libraries(program PRIVATE ZLIB::ZLIB)

Back in the developer command prompt, run:

cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE="%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake" -S . -B build_msvc
ninja -C build_msvc
build_msvc\program.exe

and check that a reasonable zlib version is printed.

Back in the developer command prompt, verify that the copy of CMake can be customized by running:
```
vcpkg-shell use microsoft:cmake
cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE="%VCPKG_ROOT%\scripts\buildsystems\vcpkg.cmake" -S . -B build_artifact
ninja -C build_artifact
build_artifact\program.exe
```
and check that the cmake version acquired by artifacts is printed during the cmake configure, and that a reasonable zlib version is printed.
Close Visual Studio.
Back in the developer command prompt, run:
```
vcpkg add artifact microsoft:cmake
```
Open Visual Studio and use "Open Folder" on the directory containing the vcxproj. Verify that vcpkg activation happens in the terminal.

12 KiB Исходник Постоянная ссылка Ответственный История

vcpkg_tool_release_process

Release Data Flow

Smoke Testing VS

12 KiB

Исходник Постоянная ссылка Ответственный История