mirror of
https://github.com/microsoft/PowerToys
synced 2025-08-22 18:17:19 +00:00
d26ef36e31
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? --> ## Summary of the Pull Request <!-- Please review the items on the PR checklist before submitting--> ## PR Checklist - [ ] Closes: #xxx - [ ] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [ ] **Tests:** Added/updated and all pass - [ ] **Localization:** All end-user-facing strings can be localized - [ ] **Dev docs:** Added/updated - [ ] **New binaries:** Added on the required places - [ ] [JSON for signing](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ESRPSigning_core.json) for new binaries - [ ] [WXS for installer](https://github.com/microsoft/PowerToys/blob/main/installer/PowerToysSetup/Product.wxs) for new binaries and localization folder - [ ] [YML for CI pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/ci/templates/build-powertoys-steps.yml) for new test projects - [ ] [YML for signed pipeline](https://github.com/microsoft/PowerToys/blob/main/.pipelines/release.yml) - [ ] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx <!-- Provide a more detailed description of the PR, other things fixed, or any additional comments/features here --> ## Detailed Description of the Pull Request / Additional comments 1. Add instructions to build installer locally with a script 2. Add doc explaining how to install an installer by winget locally. <!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well --> ## Validation Steps Performed
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
## If for any reason, you'd like to test winget install scenario, you can follow this doc:
|
|
|
|
### Powertoys winget manifest definition:
|
|
[winget repository](https://github.com/microsoft/winget-pkgs/tree/master/manifests/m/Microsoft/PowerToys)
|
|
|
|
### How to test a winget installation locally:
|
|
1. Get artifacts from release CI pipeline Pipelines - Runs for PowerToys Signed YAML Release Build, or you can build one yourself by execute the
|
|
'tools\build\build-installer.ps1' script
|
|
|
|
2. Get the artifact hash, this is required to define winget manifest
|
|
```powershell
|
|
cd /path/to/your/directory/contains/installer
|
|
Get-FileHash -Path ".\<Installer-name>.exe" -Algorithm SHA256
|
|
```
|
|
3. Host your installer.exe - Attention: staged github release artifacts or artifacts in release pipeline is not OK in this step
|
|
You can self-host it or you can upload to a publicly available endpoint
|
|
**How to selfhost it** (A extremely simple way):
|
|
```powershell
|
|
python -m http.server 8000
|
|
```
|
|
|
|
4. Download a version folder from wingetpkgs like: [version 0.92.1](https://github.com/microsoft/winget-pkgs/tree/master/manifests/m/Microsoft/PowerToys/0.92.1)
|
|
and you get **a folder contains 3 yml files**
|
|
>note: Do not put any files other than these three in this folder
|
|
|
|
5. Modify the yml files based on your version and the self hosted artifact link, and modify the sha256 hash for the installer you'd like to use
|
|
|
|
6. Start winget install:
|
|
```powershell
|
|
#execute as admin
|
|
winget settings --enable LocalManifestFiles
|
|
winget install --manifest "<folder_path_of_manifest_files>" --architecture x64 --scope user
|
|
``` |