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.

Sign up for GitHub

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

Cross-platform support #518

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Cross-platform support #518

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a60d338
Cross-platform support
vedantmgoyal9 Nov 22, 2024
0bc6a38
Discard changes to src/WingetCreateCLI/Models/SettingsModel.cs
vedantmgoyal9 Nov 24, 2024
bea7944
Discard changes to CONTRIBUTING.md
vedantmgoyal9 Nov 24, 2024
950c506
Apply suggestions from code review
vedantmgoyal9 Nov 26, 2024
8c8c70e
Address review comments
vedantmgoyal9 Nov 26, 2024
4326571
Use XDG base directory specification
vedantmgoyal9 Nov 26, 2024
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
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
*.userosscache
*.sln.docstates

# Thumbnails (macOS)
._*

# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

Expand Down Expand Up @@ -186,7 +189,7 @@ publish/
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
# *.pubxml
*.publishproj

# Microsoft Azure Web App publish settings. Comment the next line if you want to
Expand Down
6 changes: 6 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "src/WingetCreateCore/Common/Msi/rust-msi"]
path = src/WingetCreateCore/Common/Msi/rust-msi\
# TODO: Switch to mdsteele/rust-msi once the PR is merged
# https://github.com/mdsteele/rust-msi/pull/18
url = https://github.com/vedantmgoyal9/rust-msi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can just include an external repository as a submodule and then build it blindly; that seems like a security risk. At the very least, it should point to a specific commit so that we cannot get unknown, unexpected changes.

We have internal policies/procedures for evaluating new OSS we use, but I'm not that familiar with them. I need review them or ask someone else on the team..

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pinned to a specific commit.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that is still pointing to a branch, which can get newer commits at any time

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@florelis https://github.com/vedantmgoyal9/winget-create/tree/main/src/WingetCreateCore/Common/Msi

shallow = true
8 changes: 7 additions & 1 deletion .vsconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
"version": "1.0",
"components": [
"Microsoft.VisualStudio.Workload.ManagedDesktop",
"Microsoft.VisualStudio.Workload.Universal"
"Microsoft.VisualStudio.Workload.Universal",
"Microsoft.VisualStudio.Component.Windows11SDK.26100",
"Microsoft.VisualStudio.Component.VC.Tools.ARM64",
"Microsoft.VisualStudio.Component.VC.Tools.ARM64EC"
],
"extensions": [
"https://marketplace.visualstudio.com/items?itemName=VisualStudioClient.MicrosoftVisualStudio2022InstallerProjects"
]
}
120 changes: 61 additions & 59 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

# Welcome to the Windows Package Manager Manifest Creator repository.

This repository contains the source code for the Windows Package Manager Manifest Creator. The Windows Package Manager Manifest Creator is designed to help generate or update manifest files for the [Community repo](https://github.com/microsoft/winget-pkgs).
This repository contains the source code for the Windows Package Manager Manifest Creator. The Windows Package Manager Manifest Creator is designed to help generate or update manifest files for the [Community repo](https://github.com/microsoft/winget-pkgs).

## Overview

Expand All @@ -15,7 +14,7 @@ For your convenience, **WingetCreate** can be acquired a number of ways.

### Install from the github repo

The **Windows Package Manager Manifest Creator** is available for download from the [winget-create](https://github.com/microsoft/winget-create/releases) repository. To install the package, simply click the the MSIX file in your browser. Once it has downloaded, click open.
The **Windows Package Manager Manifest Creator** is available for download from the [winget-create](https://github.com/microsoft/winget-create/releases) repository. To install the package, simply click the the MSIX file in your browser. Once it has downloaded, click open.

### Install with Windows Package Manager

Expand Down Expand Up @@ -43,19 +42,19 @@ choco install wingetcreate

**WingetCreate** has the following commands:

| Command | Description |
| ------- | ----------- |
| [New](doc/new.md) | Command for creating a new manifest from scratch |
| [Update](doc/update.md) | Command for updating an existing manifest |
| [New-Locale](doc/new-locale.md) | Command for creating a new locale for an existing manifest |
| [Update-Locale](doc/update-locale.md) | Command for updating a locale for an existing manifest |
| [Submit](doc/submit.md) | Command for submitting an existing PR |
| [Show](doc/show.md) | Command for displaying existing manifests |
| [Token](doc/token.md) | Command for managing cached GitHub personal access tokens |
| [Settings](doc/settings.md) | Command for editing the settings file configurations |
| [Cache](doc/cache.md) | Command for managing downloaded installers stored in cache
| [Info](doc/info.md) | Displays information about the client |
| [-?](doc/help.md) | Displays command line help |
| Command | Description |
| ------------------------------------- | ---------------------------------------------------------- |
| [New](doc/new.md) | Command for creating a new manifest from scratch |
| [Update](doc/update.md) | Command for updating an existing manifest |
| [New-Locale](doc/new-locale.md) | Command for creating a new locale for an existing manifest |
| [Update-Locale](doc/update-locale.md) | Command for updating a locale for an existing manifest |
| [Submit](doc/submit.md) | Command for submitting an existing PR |
| [Show](doc/show.md) | Command for displaying existing manifests |
| [Token](doc/token.md) | Command for managing cached GitHub personal access tokens |
| [Settings](doc/settings.md) | Command for editing the settings file configurations |
| [Cache](doc/cache.md) | Command for managing downloaded installers stored in cache |
| [Info](doc/info.md) | Displays information about the client |
| [-?](doc/help.md) | Displays command line help |

Click on the individual commands to learn more.

Expand All @@ -72,22 +71,22 @@ You can also check out this [episode of Open at Microsoft](https://learn.microso

### Using the standalone exe:

The latest version of the standalone exe can be found at https://aka.ms/wingetcreate/latest, and the latest preview version can be found at https://aka.ms/wingetcreate/preview, both of these require [.NET Runtime 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) to be installed on the build machine. To install this on your build machine in your pipeline, you can include the following dotnet task:
The latest version of the standalone exe can be found at https://aka.ms/wingetcreate/latest, and the latest preview version can be found at https://aka.ms/wingetcreate/preview, both of these require [.NET Runtime 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) to be installed on the build machine. To install this on your build machine in your pipeline, you can include the following dotnet task:

```yaml
- task: UseDotNet@2
displayName: 'Install .NET Runtime'
inputs:
packageType: sdk
version: '6.x'
installationPath: '$(ProgramFiles)\dotnet'
- task: UseDotNet@2
displayName: 'Install .NET Runtime'
inputs:
packageType: sdk
version: '8.x'
installationPath: '$(ProgramFiles)\dotnet'
```

Or you can utilize a PowerShell task and run the following script.

```PowerShell
Invoke-WebRequest https://dot.net/v1/dotnet-install.ps1 -OutFile dotnet-install.ps1
.\dotnet-install.ps1 -Runtime dotnet -Architecture x64 -Version 6.0.13 -InstallDir $env:ProgramFiles\dotnet
.\dotnet-install.ps1 -Runtime dotnet -Architecture x64 -Version 8 -InstallDir $env:ProgramFiles\dotnet
```

> [!IMPORTANT]
Expand All @@ -109,14 +108,14 @@ Windows Server 2022 now supports App Execution Aliases, which means the alias `w

```yaml
- powershell: |
# Download and install C++ Runtime framework package.
iwr https://aka.ms/Microsoft.VCLibs.x64.14.00.Desktop.appx -OutFile $(vcLibsBundleFile)
Add-AppxPackage $(vcLibsBundleFile)

# Download Winget-Create msixbundle, install, and execute update.
iwr https://aka.ms/wingetcreate/latest/msixbundle -OutFile $(appxBundleFile)
Add-AppxPackage $(appxBundleFile)
wingetcreate update Microsoft.WingetCreate -u $(packageUrl) -v $(manifestVersion) -t $(GITHUB_PAT) --submit
# Download and install C++ Runtime framework package.
iwr https://aka.ms/Microsoft.VCLibs.x64.14.00.Desktop.appx -OutFile $(vcLibsBundleFile)
Add-AppxPackage $(vcLibsBundleFile)

# Download Winget-Create msixbundle, install, and execute update.
iwr https://aka.ms/wingetcreate/latest/msixbundle -OutFile $(appxBundleFile)
Add-AppxPackage $(appxBundleFile)
wingetcreate update Microsoft.WingetCreate -u $(packageUrl) -v $(manifestVersion) -t $(GITHUB_PAT) --submit
```

The CLI also supports creating or updating manifests with multiple installer URLs. You can either create new manifests with multiple installer nodes using the [New Command](doc/new.md) or update existing manifests with multiple installer URLs using the [Update Command](doc/update.md).
Expand All @@ -141,28 +140,30 @@ You can install the prerequisites in one of two ways:

1. Clone the repository
2. Configure your system
* Please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
* [Dev Home](https://github.com/microsoft/devhome)'s machine configuration tool
* WinGet configuration. If you have WinGet version [v1.6.2631 or later](https://github.com/microsoft/winget-cli/releases), run `winget configure .configurations/configuration.dsc.yaml` in an elevated shell from the project root so relative paths resolve correctly
* Alternatively, if you already are running the minimum OS version, have Visual Studio installed, and have developer mode enabled, you may configure your Visual Studio directly via the .vsconfig file. To do this:
* Open the Visual Studio Installer, select “More” on your product card and then "Import configuration"
* Specify the .vsconfig file at the root of the repo and select “Review Details”
- Please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
florelis marked this conversation as resolved.
Show resolved Hide resolved
- [Dev Home](https://github.com/microsoft/devhome)'s machine configuration tool
- WinGet configuration. If you have WinGet version [v1.6.2631 or later](https://github.com/microsoft/winget-cli/releases), run `winget configure .configurations/configuration.dsc.yaml` in an elevated shell from the project root so relative paths resolve correctly
- Alternatively, if you already are running the minimum OS version, have Visual Studio installed, and have developer mode enabled, you may configure your Visual Studio directly via the .vsconfig file. To do this:
- Open the Visual Studio Installer, select “More” on your product card and then "Import configuration"
- Specify the .vsconfig file at the root of the repo and select “Review Details”

#### Manual set up

* Windows 10 1709 (16299) or later
* [Developer mode enabled](https://docs.microsoft.com/windows/uwp/get-started/enable-your-device-for-development) (optional)
* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
* Or use winget to install it ;) (although you may need to adjust the workloads via Tools -> Get Tools and Features...)
* [Git Large File Storage (LFS)](https://git-lfs.github.com/)
* The following workloads:
* .NET Desktop Development
* Universal Windows Platform Development
* Windows 11 SDK (10.0.22000.0) (Tools -> Get Tools and Features -> Individual Components)
- Windows 10 1709 (16299) or later
- [Developer mode enabled](https://docs.microsoft.com/windows/uwp/get-started/enable-your-device-for-development)
- [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
- Or use winget to install it ;) (although you may need to adjust the workloads via Tools -> Get Tools and Features...)
- [Git Large File Storage (LFS)](https://git-lfs.github.com/)
- The following VS workloads, individual components and extensions:
- .NET Desktop Development (Workload)
- Windows application development (Workload)
- MSVC - VS2022 C++ ARM64/ARM64EC build tools (Latest) (Individual component)
- Windows 11 SDK (10.0.26100.0) (Individual component)
- Microsoft Visual Studio Installer Projects 2022 (Extension)

### Building

Open `winget-create\src\WingetCreateCLI.sln` in Visual Studio and build. We currently only build using the solution; command line methods of building a VS solution should work as well.
Open `winget-create\src\WingetCreateCLI.sln` in Visual Studio and build. We currently only build using the solution; command-line methods of building a VS solution should work as well.

## Testing the client

Expand All @@ -172,24 +173,25 @@ Running unit and E2E tests are a great way to ensure that functionality is prese

### Testing Prerequisites

* Fork the [winget-pkgs-submission-test repository](https://github.com/microsoft/winget-pkgs-submission-test)
* Fill out the test parameters in the `WingetCreateTests/Test.runsettings` file
* `WingetPkgsTestRepoOwner`: The repository owner of the winget-pkgs-submission-test repo. (Repo owner must be forked from main "winget-pkgs-submission-test" repo)
* `WingetPkgsTestRepo`: The winget-pkgs test repository. (winget-pkgs-submission-test)
* `GitHubApiKey`: GitHub personal access token for testing.
* Instructions on [how to generate your own GitHubApiKey](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
* Direct link to GitHub [Personal Access Tokens page](https://github.com/settings/tokens).
* `GitHubAppPrivateKey`: Leave blank, this is only used by the build server.
- Fork the [winget-pkgs-submission-test repository](https://github.com/microsoft/winget-pkgs-submission-test)
- Fill out the test parameters in the `WingetCreateTests/Test.runsettings` file

- `WingetPkgsTestRepoOwner`: The repository owner of the winget-pkgs-submission-test repo. (Repo owner must be forked from main "winget-pkgs-submission-test" repo)
- `WingetPkgsTestRepo`: The winget-pkgs test repository. (winget-pkgs-submission-test)
- `GitHubApiKey`: GitHub personal access token for testing.
- Instructions on [how to generate your own GitHubApiKey](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
- Direct link to GitHub [Personal Access Tokens page](https://github.com/settings/tokens).
- `GitHubAppPrivateKey`: Leave blank, this is only used by the build server.

* Set the solution wide runsettings file for the tests
* Go to `Test` menu > `Configure Run Settings` -> `Select Solution Wide runsettings File` -> Choose your configured runsettings file
- Set the solution-wide runsettings file for the tests
- Go to `Test` menu > `Configure Run Settings` -> `Select Solution Wide runsettings File` -> Choose your configured runsettings file

> [!CAUTION]
> You should treat your access token like a password. To avoid exposing your PAT, be sure to reset changes to the `WingetCreateTests/Test.runsettings` file before committing your changes. You can also use the command `git update-index --skip-worktree src/WingetCreateTests/WingetCreateTests/Test.runsettings` command to untrack changes to the file and prevent it from being committed.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. More
information is available in our [CONTRIBUTING.md](/CONTRIBUTING.md) file.
Expand Down
Loading