Skip to content

Add breaking change documentation for project.json removal from dotnet restore #47986

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 16, 2025

This PR adds comprehensive breaking change documentation for the removal of project.json support from dotnet restore in .NET 10 Preview 7.

Changes Made

New Breaking Change Document: Created complete documentation following the standard Microsoft breaking change format at /docs/core/compatibility/sdk/10.0/dotnet-restore-project-json-unsupported.md including:

  • Clear description of the breaking change behavior
  • Proper categorization as a "Source incompatible" change
  • Historical context about project.json deprecation since 2017
  • Migration guidance pointing to legacy dotnet migrate command and PackageReference format
  • Reference to official NuGet migration documentation

Updated Documentation Index: Added the new breaking change to the main compatibility table in /docs/core/compatibility/10.0.md under the SDK and MSBuild section with proper ordering and categorization.

Updated Table of Contents: Added the new entry to /docs/core/compatibility/toc.yml in the appropriate alphabetical position within the SDK and MSBuild section for .NET 10.

Validation

  • ✅ Follows Microsoft documentation style guidelines from .github/copilot-instructions.md
  • ✅ Uses the breaking change template from .github/prompts/breaking-change.md
  • ✅ Markdown syntax validated with markdownlint-cli2
  • ✅ All internal links verified to exist
  • ✅ Consistent formatting with existing breaking change documentation

The documentation properly explains that starting with .NET 10 Preview 7, dotnet restore will ignore project.json based projects rather than restoring their dependencies, completing the transition away from the format that was deprecated in 2017 and replaced by PackageReference.

Fixes #47968.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copy link
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@Copilot Copilot AI changed the title [WIP] [Breaking change]: project.json is no longer supported in dotnet.exe restore Add breaking change documentation for project.json removal from dotnet restore Aug 16, 2025
@Copilot Copilot AI requested a review from gewarren August 16, 2025 00:54
Copilot finished work on behalf of gewarren August 16, 2025 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Breaking change]: project.json is no longer supported in dotnet.exe restore
2 participants