Replacing VSWhere with MSBuild.Locator

reqnroll / Reqnroll

Open-source Cucumber-style BDD test automation framework for .NET.

https://reqnroll.net

BSD 3-Clause "New" or "Revised" License

310 stars 32 forks source link

Replacing VSWhere with MSBuild.Locator #75

Closed Tiberriver256 closed 4 months ago

Tiberriver256 commented 4 months ago

This should expand MSBuild discovery to include dotnet SDK installations allowing developers to use other tooling besides Visual Studio (i.e., JetBrains/VSCode/etc.)

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue).
[ ] New feature (non-breaking change which adds functionality).
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
[ ] Performance improvement
[ ] Refactoring (so no functional change)
[x] Other (docs, build config, etc)

Tiberriver256 commented 4 months ago

@ajeckmans / @gasparnagy

I had a chance to make a PR based on what was discussed in #74.

We're still using msbuild.exe
We've replaced VSWhere with MSBuild.Locator to expand the MSBuild search to include dotnet SDK installations as a potential location

All the CI tests pass, but at the moment, I believe the CI tests only run a small portion of the tests, so there's a potential for breakage here.

I am also not a JetBrains user, so if you could try it out for us, @ajeckmans, and see if it works better for you locally, that would be awesome.

gasparnagy commented 4 months ago

Thank you @Tiberriver256! This looks good. If @ajeckmans sends an OK signal, we should squash & merge this.

Technical side note: In general, I suggest that the ones who are already in the contributors or the core team groups to do the PRs from branches of this repo directly (without forking), because that way it is easier for others (like in this case @ajeckmans) to try it out or even making small fixes.

Tiberriver256 commented 4 months ago

Sounds good @gasparnagy. I'll plan on using branches moving forward. Let me know if you want me to close this PR and reopen a new one from a branch.

gasparnagy commented 4 months ago

@Tiberriver256 not at all. Was just a comment for the future.

ajeckmans commented 4 months ago

I'll not be able to check this today. It will have to wait till tomorrow. I'm also fine with just merging this. If it works for the CI and building in Visual Studio at least it won't make things worse :)

looking at the documentation this will either fix the issue immediately in a Rider only environment because of point 2 of this search order list: https://github.com/microsoft/MSBuildLocator?tab=readme-ov-file#how-locator-searches-for-net-sdk Or it will at least give a way to make it work using any of the other search locations :)