Skip to content

Fix AndroidPackagingOptionsExclude so it can be overridden in the csproj #8459

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.

Sign up for GitHub

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

Merged
jonpryor merged 8 commits into from
Nov 20, 2023
Merged

Fix AndroidPackagingOptionsExclude so it can be overridden in the csproj #8459

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f249070
Initial Commit
dellis1972 Oct 25, 2023
575cd41
Add Tests
dellis1972 Oct 25, 2023
bee8e2d
Updated test
dellis1972 Oct 25, 2023
ca58877
Add Docs
dellis1972 Oct 26, 2023
055f155
Change docs
dellis1972 Nov 1, 2023
221dbea
update docs
dellis1972 Nov 2, 2023
a93b220
update docs
dellis1972 Nov 2, 2023
faf297e
update docs
dellis1972 Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add Docs
  • Loading branch information
@dellis1972
dellis1972 committed Nov 7, 2023
commit ca5887729eaabd6fe8e6ca2c58afb01176c5b78f
28 changes: 28 additions & 0 deletions Documentation/guides/building-apps/build-items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,36 @@ This is so MSBuild does not try to interpret them as actual file wildcards.
NOTE: `*`, `?` and `.` will be replaced in the `BuildApk` task with the
appropriate RegEx expressions.

If the default file glob is too restrictive you can remove it by adding the
following to your csproj

```
<ItemGroup>
<AndroidPackagingOptionsExclude Remove="$([MSBuild]::Escape('*.kotlin_*')" />
</ItemGroup>
```

Added in Xamarin.Android 13.1 and .NET 7.

## AndroidPackagingOptionsInclude

A set of file glob compatible items which will allow for items to be
included from the final package. The default values are as follows

```
<ItemGroup>
<AndroidPackagingOptionsInclude Include="$([MSBuild]::Escape('*reflect.kotlin_builtins')" />
</ItemGroup>
```
Items can use file blob characters for wildcards such as `*` and `?`.
However these Items MUST use URL encoding or '$([MSBuild]::Escape(''))'.
Copy link
Contributor

@jonpryor jonpryor Oct 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph confuses me: it appears to be saying that wildcards such as * and ? "MUST use URL encoding", but the examples here don't use URL encoding, so…???

Or are you trying to say that if you want to specify a regex instead of a glob, you need to URL encode?

This doesn't make sense either, because we always treat the value as a fileglob: https://github.com/xamarin/xamarin-android/blob/57337eda1f0d6b8533b3e3a98eb015b037f8ac5c/src/Xamarin.Android.Build.Tasks/Tasks/BuildApk.cs#L347-L363

Copy link
Contributor Author

@dellis1972 dellis1972 Nov 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The URL encoding or MSBuild::Escape is needed because if you just did

<AndroidPackagingOptionsExclude Include="*.kotlin_*" />

The MSBuild Parsers would try to find files on disk called '.kotlin_' put those in the ItemGroup. So the values passed into BuildApk would be empty. Its the line below that paragraph that gives the explanation as to why it needs to be URL encoded.

This is so MSBuild does not try to interpret them as actual file wildcards.

NOTE: `*`, `?` and `.` will be replaced in the `BuildApk` task with the
appropriate RegEx expressions.

Added in .NET 9.
Copy link
Member

@jonathanpeppers jonathanpeppers Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this fixes an issue, is there any chance we'd take this to .NET 8 servicing?

Copy link
Contributor Author

@dellis1972 dellis1972 Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't fix an issue, it is a new feature. So my guess is that won't qualify for backporting.

Copy link
Member

@jonathanpeppers jonathanpeppers Oct 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I thought it might fix: #8456

If we have a way to include/exclude more or less files.

Copy link
Contributor Author

@dellis1972 dellis1972 Oct 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does fix #8456 in that it moves the the ItemGroup to AutoImport.props, but the new ItemGroup is not required to fix that issue.


## AndroidResource

All files with an *AndroidResource* build action are compiled into
Expand Down