Fix: Adjust Setup PowerShell Scripts to Run on Barebones Windows #1277
Conversation
This file contains 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
The setup scripts, msvcsetup.ps1 or gccsetup.ps1, attempt to install
necessary prerequisites, and configure the environment, so the
Pistache library can be built, tested and installed. We have made a
number of improvements to the scripts to handle Windows machines that
have a minimum of prerequisites prior to the setup script being run.
The scripts have also been extended to allow them to run without
admininstrative privileges; if admininstrative privileges are required
during setup, a new process/shell with admin rights is launched.
commonsetup.ps1
- Add git to path when newly installed by winget
(This applies generally to apps newly installed by winget. Although
winget adjusts the path to reflect the newly installed app, that
path adjustment takes effect only after we have started a new
shell. So for the benefit of the current shell, we add the
newly-installed app to the path)
- Add more extensive output instructions telling the user to configure
git when it is installed by our script.
- Install Visual Studio earlier in the script, for the benefit of
cmake.
- Use Visual Studio's cmake if needed
- Correctly capture the result (success or failure) of commands whose
output is being piped to null. E.g.
($brotli_there = (vcpkg list "brotli")) *> $null
- Invoke python to test if Python is present. Doing Get-Command
doesn't work for Python.
- Cope with long paths created in C:\Users\<name>\AppData in
Windows 11 2H24.
- Suppress pip3 warning
- Uninstall non-openssl curl if needed
- Implement the mechanism for getting admin rights when needed
- Throw if running in a 32-bit shell
- Get admin rights if needed before installing git
- After installing git, exit with instructions on git configuration
- When looking for existing vcpkg.exe, exclude Visual Studio version;
Visual Studio version does not have the capability to install new
packages in the way we'd want.
- Get admin rights if needed before installing vcpkg
- When checking for existing Visual Studio, check it's not empty
- Get admin rights if needed before installing Visual Studio
- Run Visual Studio installer with no GUI
- Use vcpkg pkg-config if winget pkg-config package not available
- Get admin rights if needed before installing googletest and zlib
- Grant user write-access to "pistache_distribution" folder
- Do git install/configure first, so if script has to exit from git
install in a raised-privilege prompt, the script running at the
lower-privileged prompt that caused the privilege-raise does not
get confused.
- Use "accept-source-agreements" with winget (for Windows Store TOS)
- Before doing "python --version" to check for python, first do
"Get-Command python". Needed on Windows Server 2019.
- When checking for existing doxygen install, check $env:ProgramFiles
and ${env:ProgramFiles(x86)}, not just the the user's home folder,
in case we are executing at lower privilege but doxygen was
installed in the system by a script running at a higher privilege.
gccsetup.ps1:
- Correct syntax used in expansion of msys2
- Add ninja to current path when newly installed by winget
- Get admin rights if needed before installing msys2
msvcsetup.ps1:
- Add ninja to current path when newly installed by winget
- Skip configuring Visual Studio prompt if in a temporary
administrator shell (which will exit before the prompt can be used)
tests/meson.build
- Use Copy-Item, rather than creating a symbolic link where
needed. Creation of a symbolic link can require admin rights in
Windows.
installmanatinstall.ps1
- Raise to admin level if needed when installing logging manifest
Building on Windows.txt
- Add note on setting ExecutionPolicy so scripts can execute
- Add note on disabling Enhanced Security Configuration for IE
- Add note on fixing mingit circular config-file includes
kiplingw
approved these changes
Jan 4, 2025
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.
The setup scripts, msvcsetup.ps1 or gccsetup.ps1, attempt to install necessary prerequisites, and configure the environment, so the Pistache library can be built, tested and installed. We have made a number of improvements to the scripts to handle Windows machines that have a minimum of prerequisites prior to the setup script being run. For instance, they will now execute even there is no git, no compiler, and no package manager on the Windows machine.
The scripts have also been extended to allow them to run without administrative privileges; if administrative privileges are required during setup, a new process/shell with admin rights is launched automatically.
See commit message for more details.