List of Breaking/Planned changes for MSBuild.Locator v2.0

Open
#282 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
csharp
Domain
build-system, tooling

Research direction

Start with the planned changes in the issue and review VisualStudioInstanceQueryOptions.cs, then read the linked issues for compatibility warnings, SDK resolution, and version clashes. The scope spans several API and behavior changes, so completion would require an agreed v2.0 plan and corresponding resolution of the referenced cases.

Written by the indexing model from the issue text.

Description

  1. Remove extra property AllowQueryAllRuntimeVersions. AllowAllRuntimeVersions from VisualStudioInstanceQueryOptions.cs means the same, but can't clean up immediately due to backward compatibility.
  2. There is a request to add a warning message about the possible compatibility issues - sometimes MSBuild that is being loaded is just too old to have modern things. https://github.com/microsoft/MSBuildLocator/issues/272 & https://github.com/microsoft/MSBuildLocator/issues/130
    Change API to...
class MSBuildLocationResult
{
  public bool IsCompatibleWithCurrentRuntime;
  public MSBuildLocatorWarning[] Warnings;
  public string RootPath;
  public MSBuildDiscoveryType Context;

  public Version Version;
  public Architecture Architecture; 


  public void Register() {}
}
  1. https://github.com/dotnet/msbuild/issues/8166 - compatibility warning
  2. https://github.com/microsoft/MSBuildLocator/issues/254 - can be also a part of compatibility warning section
  3. https://github.com/microsoft/MSBuildLocator/issues/83 - find the way to implement this
  4. Add handling for the case described here: https://github.com/dotnet/msbuild/issues/9869#issuecomment-2007817375
  5. Handle the case for the versions clash: https://github.com/dotnet/msbuild/issues/10228
  6. Improve the error message for sdk resolution: https://github.com/microsoft/MSBuildLocator/issues/331
Dominant language
C#
Stars
262
Forks
91
Avg merge
11d 22h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/MSBuildLocator

All issues in microsoft/MSBuildLocator

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.