-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Expand upgrade documentation with version pinning and controlled upgrade guidance #49510
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
Conversation
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation on version pinning strategies for .NET development and formats a table in the code analysis configuration options document. The PR enhances the upgrade guide with detailed instructions for maintaining build predictability while upgrading development tools.
Key changes include:
- Added new "Controlled upgrades and version pinning" and "Version pinning" sections with detailed guidance
- Added
ai-usage: ai-assistedfrontmatter to indicate AI assistance - Reformatted a severity configuration table for improved alignment
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/fundamentals/code-analysis/configuration-options.md | Reformatted the severity configuration table with improved column alignment |
| docs/core/install/upgrade.md | Added comprehensive version pinning documentation covering SDK, analyzers, NuGet packages, and MSBuild version control |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved. Looks great to me.
- Clear, actionable, technically correct, and well placed in appropriate sections.
- Code samples look good.
A duplicate of a link is provided in the See Also, but that is a really minor item, and might be worth restating at the bottom of the doc anyway.
Addresses #355904. Developers upgrading to new .NET/Visual Studio versions face unexpected analyzer warnings, SDK behavior changes, and breaking changes that disrupt builds. The existing upgrade documentation only covered high-level steps without guidance on controlling these transitions.
New Sections
Example: Pinning SDK and Analyzer Versions
This allows upgrading Visual Studio 17.12 and .NET 9 SDK while maintaining stable builds until ready to adopt new features incrementally.
cc @baronfel @rainersigwald @jaredpar @anangaur @zivkan
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Internal previews