diff --git a/docs/BuildErrors.md b/docs/BuildErrors.md new file mode 100644 index 000000000000..be5f94a56082 --- /dev/null +++ b/docs/BuildErrors.md @@ -0,0 +1,17 @@ +Build Errors +------------ + +This document is for common build errors and how to resolve them. + +### Warning BUILD001 + +> warning BUILD001: Package references changed since the last release... + +This warning indicates a breaking change might have been made to a package or assembly due to the removal of a reference which was used +in a previous release of this assembly. See <./ReferenceResolution.md> for how to suppress. + +### Error BUILD002 + +> error BUILD002: Package references changed since the last release... + +Similar to BUILD001, but this error is not suppressable. This error only appears in servicing builds, which should not change references between assemblies or packages. diff --git a/docs/ReferenceResolution.md b/docs/ReferenceResolution.md index 4acb23b2b83a..7d1e20c0cc25 100644 --- a/docs/ReferenceResolution.md +++ b/docs/ReferenceResolution.md @@ -25,6 +25,7 @@ The requirements that led to this system are: * Name the .csproj file to match the assembly name. * Run `build.cmd /t:GenerateProjectList` when adding new projects * Use [eng/tools/BaseLineGenerator/](/eng/tools/BaselineGenerator/README.md) if you need to update baselines. +* If you need to make a breaking change to dependencies, you may need to add ``. ## Important files @@ -67,3 +68,16 @@ Steps for adding a new package dependency to an existing project. Let's say I'm If you don't know the commit hash of the source code used to produce "0.0.1-beta-1", you can use `000000` as a placeholder for `Sha` as its value is unimportant and will be updated the next time the bot runs. + +## Example: make a breaking change to references + +If Microsoft.AspNetCore.Banana in 2.1 had a reference to `Microsoft.AspNetCore.Orange`, but in 3.0 this reference is changing to `Microsoft.AspNetCore.BetterThanOrange`, you would need to make these changes to the .csproj file + +```diff + + +- ++ ++ + +``` diff --git a/eng/targets/ResolveReferences.targets b/eng/targets/ResolveReferences.targets index 3eeface237fa..204c281f88da 100644 --- a/eng/targets/ResolveReferences.targets +++ b/eng/targets/ResolveReferences.targets @@ -148,6 +148,8 @@ + + + + + diff --git a/src/SignalR/common/Http.Connections.Common/src/Microsoft.AspNetCore.Http.Connections.Common.csproj b/src/SignalR/common/Http.Connections.Common/src/Microsoft.AspNetCore.Http.Connections.Common.csproj index 6b877415aa61..334dbdd502c4 100644 --- a/src/SignalR/common/Http.Connections.Common/src/Microsoft.AspNetCore.Http.Connections.Common.csproj +++ b/src/SignalR/common/Http.Connections.Common/src/Microsoft.AspNetCore.Http.Connections.Common.csproj @@ -24,4 +24,9 @@ + + + + + diff --git a/src/SignalR/common/Protocols.Json/src/Microsoft.AspNetCore.SignalR.Protocols.Json.csproj b/src/SignalR/common/Protocols.Json/src/Microsoft.AspNetCore.SignalR.Protocols.Json.csproj index a115330e1ba1..c1f31c3e5437 100644 --- a/src/SignalR/common/Protocols.Json/src/Microsoft.AspNetCore.SignalR.Protocols.Json.csproj +++ b/src/SignalR/common/Protocols.Json/src/Microsoft.AspNetCore.SignalR.Protocols.Json.csproj @@ -27,4 +27,9 @@ + + + + + diff --git a/src/SignalR/common/SignalR.Common/src/Microsoft.AspNetCore.SignalR.Common.csproj b/src/SignalR/common/SignalR.Common/src/Microsoft.AspNetCore.SignalR.Common.csproj index 66dae2f3c0cb..f5689810426b 100644 --- a/src/SignalR/common/SignalR.Common/src/Microsoft.AspNetCore.SignalR.Common.csproj +++ b/src/SignalR/common/SignalR.Common/src/Microsoft.AspNetCore.SignalR.Common.csproj @@ -29,4 +29,9 @@ + + + + + diff --git a/version.props b/version.props index 5d7bcf2f9206..228a6c4b43fd 100644 --- a/version.props +++ b/version.props @@ -8,6 +8,7 @@ Preview $(PreReleasePreviewNumber) 0.3.$(AspNetCorePatchVersion) 0.9.$(AspNetCorePatchVersion) + $(AspNetCoreMajorVersion).$(AspNetCoreMinorVersion) $(AspNetCoreMajorVersion).$(AspNetCoreMinorVersion).$(AspNetCorePatchVersion)