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.

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

Fix checklist feedback about tool and registry releases from @data-queue. #1244

Merged
merged 2 commits into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 11 additions & 3 deletions docs/vcpkg_registry_release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@

This document describes the acceptance criteria / process we use when doing a vcpkg registry release.

1. Make sure the contents of the repo have what you want to release.
1. Create a git tag for the release.
1. Submit a full CI rebuild for the tag.
```console
>git fetch origin # Where origin is whichever remote points to microsoft/vcpkg
>git switch -d origin/master
>git tag 2023.10.19 # Replace this with the correct date of course :)
>git push origin 2023.10.19
```
1. Submit a full CI rebuild ( https://dev.azure.com/vcpkg/public/_build?definitionId=29 ) for the tag. e.g. `refs/tags/2023.10.19`
1. Checkout the tag
1. Run vcpkg z-changelog `<SHA OF LAST RELEASE>` > `path/to/results.md`
1. Create a new GitHub release in the registry repo.
1. Create a new GitHub release in the registry repo on the tag.
1. Run 'auto generate release notes'
1. Change `## New Contributors` to `#### New Contributors`
1. Copy the contents to the end of `path/to/results.md` (the `#### New Contributors` part should line up)
1. Change the link to the full rebuild.
1. Fill out the block about tool release changes.
1. After the full rebuild submission completes, change all the 'Building...'s to actual counts.
1. Copy `path/to/results.md` into the github release and publish it. (You can delete `path/to/results.md` now :))
1. After the full rebuild submission completes, change all the 'Building...'s to actual counts in the release.
1. After a blog post for that release is authored, add a link to the blog post to the release.
7 changes: 5 additions & 2 deletions docs/vcpkg_tool_release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,12 @@ such as https://github.com/microsoft/vcpkg/pull/23757
1. Go to the root of the VS repo and run `init.cmd -CoreXTProfileName VSPartners`
1. 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.
1. Smoke test the copy of vcpkg inserted into VS. See smoke test steps below.
1. 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.
1. (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)
1. Mark any `requires:vcpkg-tool-release` issues as fixed by the tool release.

# Release Data Flow

Expand Down Expand Up @@ -152,7 +155,7 @@ flowchart TD

# Smoke Testing VS

1. 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.
1. 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. ( `\\vspreinstall\preinstall\preinstall.cmd` ? )
1. 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.
1. Create a new C++ console project.
Expand Down