You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Below is our guidance for how to report issues, propose new features, and submit
4
4
5
5
## Open Development Workflow
6
6
7
-
The Windows Package Manager Manifest Creator team is VERY active in this GitHub Repository. In fact, we live in it all day long and carry out all our development in the open!
7
+
The Windows Package Manager team is VERY active in this GitHub Repository. In fact, we live in it all day long and carry out all our development in the open!
8
8
9
9
When the team finds issues we file them in the repository. When we propose new ideas or think-up new features, we file new feature requests. When we work on fixes or features, we create branches and work on those improvements. And when PRs are reviewed, we review in public - including all the good, the bad, and the ugly parts.
Copy file name to clipboardExpand all lines: README.md
+61-59Lines changed: 61 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
-
2
1
# Welcome to the Windows Package Manager Manifest Creator repository.
3
2
4
-
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).
3
+
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).
5
4
6
5
## Overview
7
6
@@ -15,7 +14,7 @@ For your convenience, **WingetCreate** can be acquired a number of ways.
15
14
16
15
### Install from the github repo
17
16
18
-
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.
17
+
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.
19
18
20
19
### Install with Windows Package Manager
21
20
@@ -43,19 +42,19 @@ choco install wingetcreate
43
42
44
43
**WingetCreate** has the following commands:
45
44
46
-
| Command | Description |
47
-
| -------|----------- |
48
-
|[New](doc/new.md)| Command for creating a new manifest from scratch |
49
-
|[Update](doc/update.md)| Command for updating an existing manifest |
50
-
|[New-Locale](doc/new-locale.md)| Command for creating a new locale for an existing manifest |
51
-
|[Update-Locale](doc/update-locale.md)| Command for updating a locale for an existing manifest |
52
-
|[Submit](doc/submit.md)| Command for submitting an existing PR |
53
-
|[Show](doc/show.md)| Command for displaying existing manifests |
54
-
|[Token](doc/token.md)| Command for managing cached GitHub personal access tokens |
55
-
|[Settings](doc/settings.md)| Command for editing the settings file configurations |
56
-
| [Cache](doc/cache.md) | Command for managing downloaded installers stored in cache
57
-
|[Info](doc/info.md)| Displays information about the client |
|[New](doc/new.md)| Command for creating a new manifest from scratch|
48
+
|[Update](doc/update.md)| Command for updating an existing manifest|
49
+
|[New-Locale](doc/new-locale.md)| Command for creating a new locale for an existing manifest |
50
+
|[Update-Locale](doc/update-locale.md)| Command for updating a locale for an existing manifest|
51
+
|[Submit](doc/submit.md)| Command for submitting an existing PR|
52
+
|[Show](doc/show.md)| Command for displaying existing manifests|
53
+
|[Token](doc/token.md)| Command for managing cached GitHub personal access tokens|
54
+
|[Settings](doc/settings.md)| Command for editing the settings file configurations|
55
+
|[Cache](doc/cache.md)| Command for managing downloaded installers stored in cache|
56
+
|[Info](doc/info.md)| Displays information about the client|
57
+
|[-?](doc/help.md)| Displays command line help|
59
58
60
59
Click on the individual commands to learn more.
61
60
@@ -72,22 +71,22 @@ You can also check out this [episode of Open at Microsoft](https://learn.microso
72
71
73
72
### Using the standalone exe:
74
73
75
-
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:
74
+
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:
76
75
77
76
```yaml
78
-
- task: UseDotNet@2
79
-
displayName: 'Install .NET Runtime'
80
-
inputs:
81
-
packageType: sdk
82
-
version: '6.x'
83
-
installationPath: '$(ProgramFiles)\dotnet'
77
+
- task: UseDotNet@2
78
+
displayName: 'Install .NET Runtime'
79
+
inputs:
80
+
packageType: sdk
81
+
version: '8.x'
82
+
installationPath: '$(ProgramFiles)\dotnet'
84
83
```
85
84
86
85
Or you can utilize a PowerShell task and run the following script.
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).
@@ -141,28 +140,30 @@ You can install the prerequisites in one of two ways:
141
140
142
141
1. Clone the repository
143
142
2. Configure your system
144
-
* Please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
* 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
147
-
* 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:
148
-
* Open the Visual Studio Installer, select “More” on your product card and then "Import configuration"
149
-
* Specify the .vsconfig file at the root of the repo and select “Review Details”
143
+
- Please use the [configuration file](.configurations/configuration.dsc.yaml). This can be applied by either:
- 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
146
+
-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:
147
+
-Open the Visual Studio Installer, select “More” on your product card and then "Import configuration"
148
+
-Specify the .vsconfig file at the root of the repo and select “Review Details”
- Windows 11 SDK (10.0.26100.0) (Individual component)
162
+
- Microsoft Visual Studio Installer Projects 2022 (Extension)
162
163
163
164
### Building
164
165
165
-
Open `winget-create\src\WingetCreateCLI.sln` in Visual Studio and build. We currently only build using the solution; commandline methods of building a VS solution should work as well.
166
+
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.
166
167
167
168
## Testing the client
168
169
@@ -172,24 +173,25 @@ Running unit and E2E tests are a great way to ensure that functionality is prese
172
173
173
174
### Testing Prerequisites
174
175
175
-
* Fork the [winget-pkgs-submission-test repository](https://github.com/microsoft/winget-pkgs-submission-test)
176
-
* Fill out the test parameters in the `WingetCreateTests/Test.runsettings` file
177
-
* `WingetPkgsTestRepoOwner`: The repository owner of the winget-pkgs-submission-test repo. (Repo owner must be forked from main "winget-pkgs-submission-test" repo)
178
-
* `WingetPkgsTestRepo`: The winget-pkgs test repository. (winget-pkgs-submission-test)
179
-
* `GitHubApiKey`: GitHub personal access token for testing.
180
-
* Instructions on [how to generate your own GitHubApiKey](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
181
-
* Direct link to GitHub [Personal Access Tokens page](https://github.com/settings/tokens).
182
-
* `GitHubAppPrivateKey`: Leave blank, this is only used by the build server.
176
+
- Fork the [winget-pkgs-submission-test repository](https://github.com/microsoft/winget-pkgs-submission-test)
177
+
- Fill out the test parameters in the `WingetCreateTests/Test.runsettings` file
178
+
179
+
- `WingetPkgsTestRepoOwner`: The repository owner of the winget-pkgs-submission-test repo. (Repo owner must be forked from main "winget-pkgs-submission-test" repo)
180
+
- `WingetPkgsTestRepo`: The winget-pkgs test repository. (winget-pkgs-submission-test)
181
+
- `GitHubApiKey`: GitHub personal access token for testing.
182
+
- Instructions on [how to generate your own GitHubApiKey](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
183
+
- Direct link to GitHub [Personal Access Tokens page](https://github.com/settings/tokens).
184
+
- `GitHubAppPrivateKey`: Leave blank, this is only used by the build server.
183
185
184
-
* Set the solutionwide runsettings file for the tests
185
-
* Go to `Test` menu > `Configure Run Settings` -> `Select Solution Wide runsettings File` -> Choose your configured runsettings file
186
+
-Set the solution-wide runsettings file for the tests
187
+
-Go to `Test` menu > `Configure Run Settings` -> `Select Solution Wide runsettings File` -> Choose your configured runsettings file
186
188
187
189
> [!CAUTION]
188
190
> 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.
189
191
190
192
## Contributing
191
193
192
-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
194
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
193
195
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
194
196
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. More
195
197
information is available in our [CONTRIBUTING.md](/CONTRIBUTING.md) file.
0 commit comments