-
Notifications
You must be signed in to change notification settings - Fork 2k
Nuget manager skill #539
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
Merged
+69
−0
Merged
Nuget manager skill #539
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f515e3c
Add NuGet Manager skill documentation
psimsa 920f662
Update version check command in SKILL.md
psimsa 24f33dd
Update skills/nuget-manager/SKILL.md
psimsa 8d0adc6
Fix formatting of description in SKILL.md
psimsa 6e801aa
Address PR feedback
psimsa f5070a3
Merge branch 'main' into nuget-manager
psimsa 81715e6
Update readme.skills
psimsa 0db764e
Merge branch 'main' into nuget-manager
psimsa 049d58f
Merge branch 'main' into nuget-manager
psimsa 0fe897c
Merge branch 'main' into nuget-manager
codemillmatt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| name: nuget-manager | ||
| description: 'Manage NuGet packages in .NET projects/solutions. Use this skill when adding, removing, or updating NuGet package versions. It enforces using `dotnet` CLI for package management and provides strict procedures for direct file edits only when updating versions.' | ||
| --- | ||
|
|
||
| # NuGet Manager | ||
|
|
||
| ## Overview | ||
|
|
||
| This skill ensures consistent and safe management of NuGet packages across .NET projects. It prioritizes using the `dotnet` CLI to maintain project integrity and enforces a strict verification and restoration workflow for version updates. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - .NET SDK installed (typically .NET 8.0 SDK or later, or a version compatible with the target solution). | ||
| - `dotnet` CLI available on your `PATH`. | ||
| - `jq` (JSON processor) OR PowerShell (for version verification using `dotnet package search`). | ||
|
|
||
| ## Core Rules | ||
|
|
||
| 1. **NEVER** directly edit `.csproj`, `.props`, or `Directory.Packages.props` files to **add** or **remove** packages. Always use `dotnet add package` and `dotnet remove package` commands. | ||
| 2. **DIRECT EDITING** is ONLY permitted for **changing versions** of existing packages. | ||
| 3. **VERSION UPDATES** must follow the mandatory workflow: | ||
| - Verify the target version exists on NuGet. | ||
| - Determine if versions are managed per-project (`.csproj`) or centrally (`Directory.Packages.props`). | ||
| - Update the version string in the appropriate file. | ||
| - Immediately run `dotnet restore` to verify compatibility. | ||
|
|
||
| ## Workflows | ||
|
|
||
| ### Adding a Package | ||
| Use `dotnet add [<PROJECT>] package <PACKAGE_NAME> [--version <VERSION>]`. | ||
| Example: `dotnet add src/MyProject/MyProject.csproj package Newtonsoft.Json` | ||
|
|
||
| ### Removing a Package | ||
| Use `dotnet remove [<PROJECT>] package <PACKAGE_NAME>`. | ||
| Example: `dotnet remove src/MyProject/MyProject.csproj package Newtonsoft.Json` | ||
|
|
||
| ### Updating Package Versions | ||
| When updating a version, follow these steps: | ||
|
|
||
| 1. **Verify Version Existence**: | ||
| Check if the version exists using the `dotnet package search` command with exact match and JSON formatting. | ||
| Using `jq`: | ||
| `dotnet package search <PACKAGE_NAME> --exact-match --format json | jq -e '.searchResult[].packages[] | select(.version == "<VERSION>")'` | ||
psimsa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Using PowerShell: | ||
| `(dotnet package search <PACKAGE_NAME> --exact-match --format json | ConvertFrom-Json).searchResult.packages | Where-Object { $_.version -eq "<VERSION>" }` | ||
|
|
||
| 2. **Determine Version Management**: | ||
| - Search for `Directory.Packages.props` in the solution root. If present, versions should be managed there via `<PackageVersion Include="Package.Name" Version="1.2.3" />`. | ||
| - If absent, check individual `.csproj` files for `<PackageReference Include="Package.Name" Version="1.2.3" />`. | ||
|
|
||
| 3. **Apply Changes**: | ||
| Modify the identified file with the new version string. | ||
|
|
||
| 4. **Verify Stability**: | ||
| Run `dotnet restore` on the project or solution. If errors occur, revert the change and investigate. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### User: "Add Serilog to the WebApi project" | ||
| **Action**: Execute `dotnet add src/WebApi/WebApi.csproj package Serilog`. | ||
|
|
||
| ### User: "Update Newtonsoft.Json to 13.0.3 in the whole solution" | ||
| **Action**: | ||
| 1. Verify 13.0.3 exists: `dotnet package search Newtonsoft.Json --exact-match --format json` (and parse output to confirm "13.0.3" is present). | ||
| 2. Find where it's defined (e.g., `Directory.Packages.props`). | ||
| 3. Edit the file to update the version. | ||
| 4. Run `dotnet restore`. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.