Add vcpkg-release-bump workflow and bump in-repo overlay port to v3.10.161.1#1475
Open
bmehta001 wants to merge 4 commits into
Open
Add vcpkg-release-bump workflow and bump in-repo overlay port to v3.10.161.1#1475bmehta001 wants to merge 4 commits into
bmehta001 wants to merge 4 commits into
Conversation
On a published version release, open a PR to microsoft/vcpkg bumping the cpp-client-telemetry port (REF -> tag, recomputed SHA512, version, then x-add-version). Runs only on published, non-prerelease version tags (vX.Y.Z.W) or manual dispatch, and opens no PR when the port already matches the release. Requires repo variable VCPKG_FORK_REPO and secret VCPKG_BUMP_TOKEN. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Repoint tools/ports/cpp-client-telemetry REF from the pre-release commit to the published v3.10.161.1 tag (SHA512 updated) for exact parity with the official microsoft/vcpkg port. Version was already 3.10.161.1. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bmehta001
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds automation to keep the upstream microsoft/vcpkg port for cpp-client-telemetry in sync with SDK releases, and aligns the in-repo overlay port’s REF with the published v3.10.161.1 tag.
Changes:
- Add a new GitHub Actions workflow to open/update a vcpkg port bump PR when a release is published (or via manual dispatch).
- Update the in-repo overlay port (
tools/ports/.../portfile.cmake) to useREF v3.10.161.1and its corresponding SHA512.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
tools/ports/cpp-client-telemetry/portfile.cmake |
Repoint overlay port source REF/SHA512 to the published v3.10.161.1 tag for parity with the released SDK. |
.github/workflows/vcpkg-release-bump.yml |
New workflow that computes the release tarball SHA512, updates the vcpkg port files, runs vcpkg formatting/version DB update, and opens/refreshes a PR in microsoft/vcpkg. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ./vcpkg x-add-version "${PORT}" --overwrite-version | ||
| git add versions | ||
| git commit -m "[${PORT}] Update version database" | ||
| git push --force-with-lease origin "${BR}" |
Contributor
Author
There was a problem hiding this comment.
Good catch — confirmed and fixed in 5c345c8. Since the job runs in a fresh checkout, an already-existing bump branch on the fork has no refs/remotes/origin/${BR} locally, so --force-with-lease had no lease ref and the rerun push would be rejected — defeating the "force-pushed branch refreshes it" path. Added before the push:
git fetch origin "+refs/heads/${BR}:refs/remotes/origin/${BR}" || true
git push --force-with-lease origin "${BR}"
The || true keeps the first run (branch doesn't exist remotely yet) working, and on reruns the remote-tracking ref now gives the lease something to compare against. Fixed.
…alls building-with-vcpkg.md only told manifest-mode users to add `cpp-client-telemetry` to vcpkg.json, which fails with an unknown-port error until the port is accepted into the official vcpkg registry. Document the `vcpkg-configuration.json` `overlay-ports` fallback that points manifest mode at the in-repo overlay port, giving parity with the classic-mode `--overlay-ports` instructions already in the doc. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
.github/workflows/vcpkg-release-bump.yml (Copilot): `git push
--force-with-lease` could fail on reruns because a fresh clone has no
remote-tracking ref for an already-existing bump branch, so the workflow
couldn't refresh an open bump PR (contradicting the "force-pushed branch
refreshes it" intent). Fetch the branch into refs/remotes/origin/${BR}
(|| true on the first run, when it doesn't exist yet) before the
force-with-lease push so the lease has a ref to compare against.
Verified at .github/workflows/vcpkg-release-bump.yml:146-152.
docs/building-with-vcpkg.md: remove the manifest-mode overlay-ports note
added in 136e010, per maintainer request.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR bundles two vcpkg-port maintenance changes:
1.
.github/workflows/vcpkg-release-bump.yml(new)Automatically opens a version-bump PR against microsoft/vcpkg for the
cpp-client-telemetryport whenever a new SDK release is cut.When it runs
vMAJOR.MINOR.PATCH.BUILD).workflow_dispatchwith ataginput (recovery / re-runs).What it does: resolves the tag/version, computes the source SHA512, branches off vcpkg
masterin the configured fork, updatesports/cpp-client-telemetry/{portfile.cmake (REF + SHA512), vcpkg.json (version)}, runsformat-manifest+x-add-version, and opens a[cpp-client-telemetry] Update to <version>PR. The vcpkg team still reviews/merges it.One-time setup required (repo settings):
VCPKG_FORK_REPO→ the vcpkg fork to push branches to (e.g.your-org/vcpkg).VCPKG_BUMP_TOKEN→ a PAT (classic:repo+workflow, or fine-grained: Contents + Pull requests RW on the fork) able to push to the fork and open PRs on microsoft/vcpkg.Until the port is merged into the registry (PR microsoft/vcpkg#52316), the workflow fails fast with a clear message that the port must exist first.
2. Bump the in-repo overlay port to the
v3.10.161.1tagtools/ports/cpp-client-telemetry/portfile.cmakepreviously pointed at the pre-release commit4485b820. RepointedREF→ the publishedv3.10.161.1tag (SHA512 updated) for exact parity with the official microsoft/vcpkg port. (The version was already3.10.161.1from the release-prep.)