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

Remove vcpkg.ps1 and evaluate removal of vcpkg-commit.txt after updating its usage in docs #2403

Open
ahsonkhan opened this issue Nov 8, 2022 · 2 comments
Labels
Docs EngSys This issue is impacting the engineering system.

Comments

@ahsonkhan
Copy link
Member

There are no users of the vcpkg.ps1 script:

[CmdletBinding()]

Furthermore, other than the getting started docs, no one is referencing vcpkg-commit.txt. It is useful to keep to make documenting easier and having a single place to update the baseline we point to. We should make use of that in the AzureVcpkg.cmake module and vcpkg.json file (for the baseline), OR remove it.


https://github.com/Azure/azure-sdk-for-c/blob/2e375c04b00c36c9b024afbcd405d348732b1142/sdk/samples/iot/README.md#prerequisites

set(VCPKG_COMMIT_STRING f0aa678b7471497f1adedcc99f40e1599ad22f69) # default SDK tested commit

"builtin-baseline": "f0aa678b7471497f1adedcc99f40e1599ad22f69",

cc @vhvb1989, @danieljurek, @BillyONeal, @danewalton

@ahsonkhan ahsonkhan added Docs EngSys This issue is impacting the engineering system. labels Nov 8, 2022
@danieljurek
Copy link
Member

We should ideally use this string in one place. Having it in a single text file makes it easier to read for users and automation (as opposed to extracting it from a cmake file). I vote we have the cmake script read it from a file if it's easy enough to do.

@ahsonkhan
Copy link
Member Author

ahsonkhan commented Nov 10, 2022

Reading it from a file within cmake is doable (https://cmake.org/cmake/help/latest/command/file.html), but the issue is with updating that same string within the "builtin-baseline" property within the vcpkg.json file.

As an aside, the C++ SDK repo doesn't have the vcpkg-commit.txt file, how does it extract the SHA to check-out?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs EngSys This issue is impacting the engineering system.
Projects
None yet
Development

No branches or pull requests

2 participants