stryker-mutator / stryker-net

Mutation testing for .NET core and .NET framework!
https://stryker-mutator.io
Apache License 2.0
1.76k stars 175 forks source link

Stryker.NET install can fail when nuget config contains private nuget registries #1723

Closed nicojs closed 1 year ago

nicojs commented 2 years ago

Is your feature request related to a problem? Please describe.

Stryker.NET installation can fail when your nuget config contains private nuget registries.

image

<packageSources>
    <add key="azure" value="https://pkg.azure.com/cdwrt06/cdwrt06_10_2021/_packaging/Universal/nuget/v3/index.json"/>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>

Describe the solution you'd like

Improve the getting-started.md to describe the best solution. We simply removed all package sources except nuget.org, which worked. But I hope there is a better solution.

Describe alternatives you've considered

Maybe change the docs to force nuget to use nuget.org?

Additional context

Users of Nuget often don't know exactly which package sources they configured, because Visual Studio manages them as well.

rouke-broersma commented 2 years ago

For context this can be an issue because we distribute stryker as a dotnet tool which uses nuget as the distribution channel. This is not an error caused by stryker, it is simply how the ecosystem works. We can create something like an FAQ to warn users that this might be the issue they're running into but it is not something to fix in stryker.

nicojs commented 2 years ago

Yes true. Maybe add a troubleshooting guide, as we did for StrykerJS: https://stryker-mutator.io/docs/stryker-js/troubleshooting

rouke-broersma commented 1 year ago

Since there hasn't been any traction on this issue and since dotnet tools distributed through nuget are more and more common I assume modern dotnet developers are aware of this concept and documentation around this concept is not neccesary.