Skip to content

[Breaking change]: Source Link is included in the .NET SDK #37674

Closed
#37982
Closed
[Breaking change]: Source Link is included in the .NET SDK#37674
#37982
Assignees
gewarren
Labels
🏁 Release: .NET 8Work items for the .NET 8 release📌 seQUESTeredIdentifies that an issue has been imported into Quest.breaking-changeIndicates a .NET Core breaking changesource incompatibleSource code may encounter a breaking change in behavior when targeting the new version.

Description

@baronfel
baronfel
opened on Oct 23, 2023

Description

The Source Link build tooling is included in the .NET SDK as of .NET SDK 8.0.100-preview.4, which enables packages and applications to embed information about the source control information of the built artifacts. As a side effect, by default commit information will be included in the InformationalVersion of build libraries and applications.

Version

.NET 8 Preview 6

Previous behavior

Prior to this change, the default InformationalVersion of a library or application would be the Version property.

New behavior

After this change, the default InformationalVersion of a library or application would be the Version property as well as the SourceRevisionId property.

Type of breaking change

  • Binary incompatible: Existing binaries may encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
  • Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code may require source changes to compile successfully.
  • Behavioral change: Existing binaries may behave differently at run time.

Reason for change

Source Link enables very rich editor tooling, like go-to-definition support for non-local source files. We think this benefit is worth including by default for all artifacts.

Recommended action

If your build process or code is not expecting Source Revision information in the InformationalVersion, you can disable this behavior by setting the IncludeSourceRevisionInInformationalVersion property to false.

Feature area

SDK

Affected APIs

No response

Associated WorkItem - 177280

Activity

  1. baronfel
    added
    doc-idea
    breaking-changeIndicates a .NET Core breaking change
    Pri1
    on Oct 23, 2023
  2. baronfel
    assigned
    gewarren
    on Oct 23, 2023
  3. dotnet-bot
    added
    ⌚ Not TriagedNot triaged
    on Oct 23, 2023
  4. gewarren
    added this to dotnet/docs November 2023 sprinton Oct 23, 2023
  5. github-project-automation
    moved this to 🔖 Ready in dotnet/docs November 2023 sprinton Oct 23, 2023
  6. gewarren
    removed
    ⌚ Not TriagedNot triaged
    on Oct 23, 2023

  7. rainersigwald commented on Oct 23, 2023

    @rainersigwald
    rainersigwald
    on Oct 23, 2023
    Member

    @baronfel isn't this "source incompatible" rather than "behavior change"? Existing binaries don't change behavior but updating the SDK and rebuilding can change a version string.

  8. gewarren
    added
    🗺️ reQUESTTriggers an issue to be imported into Quest.
    on Oct 31, 2023
  9. dotnet-bot
    added
    source incompatibleSource code may encounter a breaking change in behavior when targeting the new version.
    on Oct 31, 2023
  10. github-actions
    added
    📌 seQUESTeredIdentifies that an issue has been imported into Quest.
    and removed
    🗺️ reQUESTTriggers an issue to be imported into Quest.
    on Nov 1, 2023
  11. gewarren
    added
    🏁 Release: .NET 8Work items for the .NET 8 release
    on Nov 2, 2023
  12. github-project-automation
    added this to .NET 8.0 work itemson Nov 2, 2023

  13. 4 remaining items

  14. arturcic
    added 6 commits that reference this issue on Nov 6, 2023

    Update SDK version and modify BuildLifetime.cs

    7542e13

    Update Target Framework Moniker to net8.0

    d050410

    Update Target Framework Moniker to net8.0

    0fb8ef6

    Update Target Framework Moniker to net8.0

    a80c5a2

    Update Target Framework Moniker to net8.0

    a4273d1

    Update Target Framework Moniker to net8.0

    36c5fc9
  15. ghost added
    in-prThis issue will be closed (fixed) by an active pull request.
    on Nov 8, 2023
  16. gewarren
    moved this from 🔖 Ready to 👀 In review in dotnet/docs November 2023 sprinton Nov 8, 2023
  17. gewarren
    closed this as completedin #37982on Nov 8, 2023
  18. github-project-automation
    moved this from 👀 In review to ✅ Done in dotnet/docs November 2023 sprinton Nov 8, 2023
  19. github-project-automation
    moved this from 🆕 New to ✅ Done in .NET 8.0 work itemson Nov 8, 2023
  20. ghost removed
    in-prThis issue will be closed (fixed) by an active pull request.
    on Nov 8, 2023

  21. DalekBaldwin commented on Dec 18, 2023

    @DalekBaldwin
    DalekBaldwin
    on Dec 18, 2023

    It would help to also document the SuppressImplicitGitSourceLink property. As it is now, in a repo with no mention of SourceLink, after you execute git commands that should leave up-to-dateness unchanged, net8.0 considers all projects to be marked for rebuilding.

  22. adurmus commented on Dec 20, 2023

    @adurmus
    adurmus
    on Dec 20, 2023

    Imagine your CI/CD relies on Product Version. Suddenly whole CI/CD operations fail because the ProductVersion cannot be parsed anymore with System.Version. Well done.

  23. Vermis0 commented on Jan 18, 2024

    @Vermis0
    Vermis0
    on Jan 18, 2024

    This also affects calls to these methods (possibly others) since they are using the ProductVersion as part of the path ("Base Path\CompanyName\ProductName\ProductVersion"):

    System.Windows.Forms.Application.UserAppDataPath
    System.Windows.Forms.Application.LocalUserAppDataPath
    System.Windows.Forms.Application.UserAppDataRegistry

    Having the data paths change after every commit instead of when the version was changed was unexpected behavior and disruptive during active development. I don't imagine a typical developer will expect to "lose" their user data on next application launch/debug just by committing a code change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

🏁 Release: .NET 8Work items for the .NET 8 release📌 seQUESTeredIdentifies that an issue has been imported into Quest.breaking-changeIndicates a .NET Core breaking changesource incompatibleSource code may encounter a breaking change in behavior when targeting the new version.

Type

No type

Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions