Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[build] Properly implement "parent directory.override.props" (#300) #873

Merged
merged 1 commit into from
Aug 25, 2021

Conversation

jonpryor
Copy link
Member

Commit 8898bc1 put too much faith into $(MSBuildProjectDirectory)). The problem is that $(MSBuildProjectDirectory)*isn't necessarily* the path toDirectory.Build.props; it's the directory for the .csproj` being built!

The intent for 8898bc1 is that e.g. xamarin/xamarin-android
should be able to create a Java.Interop.override.props file
alongside the Java.Interop git submodule, and the Java.Interop
build would use the overrides within Java.Interop.override.props.

That didn't happen; due to using $(MSBuildProjectDirectory), the
build may instead attempting to import e.g.
Java.Interop/src/Java.Interop.override.props!

    Project "$(MSBuildProjectDirectory).override.props" was not imported by "…/external/Java.Interop/Directory.Build.props" at (6,3), due to false condition;
    (Exists('$(MSBuildProjectDirectory).override.props')) was evaluated as
    (Exists('…/xamarin-android/external/Java.Interop/src/Java.Interop.override.props')).

Oops.

Fix the <Import/> expressions so that we instead try to import:

    $([System.IO.Path]::GetDirectoryName($(MSBuildThisFileDirectory))).override.props

We need $(MSBuildThisFileDirectory), as that's the easiest way to
get the checkout directory -- the directory containing
Directory.Build.props -- but $(MSBuildThisFileDirectory) always
ends in a directory separator character. Remove the directory
separator character by using Path.GetDirectoryName().

This allows e.g. the Java.Interop.csproj build to appropriately
import Java.Interop.override.props.

)

Commit 8898bc1 put too much faith into `$(MSBuildProjectDirectory)).
The problem is that `$(MSBuildProjectDirectory)` *isn't necessarily*
the path to `Directory.Build.props`; it's the directory for the
`.csproj` being built!

The *intent* for 8898bc1 is that e.g. `xamarin/xamarin-android`
should be able to create a `Java.Interop.override.props` file
alongside the `Java.Interop` git submodule, and the Java.Interop
build would use the overrides within `Java.Interop.override.props`.

That didn't happen; due to using `$(MSBuildProjectDirectory)`, the
build may instead attempting to import e.g.
`Java.Interop/src/Java.Interop.override.props`!

        Project "$(MSBuildProjectDirectory).override.props" was not imported by "…/external/Java.Interop/Directory.Build.props" at (6,3), due to false condition;
        (Exists('$(MSBuildProjectDirectory).override.props')) was evaluated as
        (Exists('…/xamarin-android/external/Java.Interop/src/Java.Interop.override.props')).

Oops.

Fix the `<Import/>` expressions so that we instead try to import:

        $([System.IO.Path]::GetDirectoryName($(MSBuildThisFileDirectory))).override.props

We need `$(MSBuildThisFileDirectory)`, as that's the easiest way to
get the checkout directory -- the directory containing
`Directory.Build.props` -- but `$(MSBuildThisFileDirectory)` always
ends in a directory separator character.  Remove the directory
separator character by using `Path.GetDirectoryName()`.

This allows e.g. the `Java.Interop.csproj` build to appropriately
import `Java.Interop.override.props`.
@jonpryor jonpryor merged commit 9a878f2 into dotnet:main Aug 25, 2021
jpobst pushed a commit that referenced this pull request Sep 30, 2021
…873)

Commit 8898bc1 put too much faith into `$(MSBuildProjectDirectory)).
The problem is that `$(MSBuildProjectDirectory)` *isn't necessarily*
the path to `Directory.Build.props`; it's the directory for the
`.csproj` being built!

The *intent* for 8898bc1 is that e.g. `xamarin/xamarin-android`
should be able to create a `Java.Interop.override.props` file
alongside the `Java.Interop` git submodule, and the Java.Interop
build would use the overrides within `Java.Interop.override.props`.

That didn't happen; due to using `$(MSBuildProjectDirectory)`, the
build may instead attempting to import e.g.
`Java.Interop/src/Java.Interop.override.props`!

        Project "$(MSBuildProjectDirectory).override.props" was not imported by "…/external/Java.Interop/Directory.Build.props" at (6,3), due to false condition;
        (Exists('$(MSBuildProjectDirectory).override.props')) was evaluated as
        (Exists('…/xamarin-android/external/Java.Interop/src/Java.Interop.override.props')).

Oops.

Fix the `<Import/>` expressions so that we instead try to import:

        $([System.IO.Path]::GetDirectoryName($(MSBuildThisFileDirectory))).override.props

We need `$(MSBuildThisFileDirectory)`, as that's the easiest way to
get the checkout directory -- the directory containing
`Directory.Build.props` -- but `$(MSBuildThisFileDirectory)` always
ends in a directory separator character.  Remove the directory
separator character by using `Path.GetDirectoryName()`.

This allows e.g. the `Java.Interop.csproj` build to appropriately
import `Java.Interop.override.props`.
@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants