- Removed `onCues` method in `Player.Listener`.
- Removed `onPositionDiscontinuity` method from `Player.Listener`.
- Added `<remove-node>` tags to address issues with `Media3.ExoPlayer`.
- Made all methods in `Player.Listener` interface abstract.
Remove the following package-specific templates in favor of using the default template:
- accompanist
- antmedia-rtpm-client
- auto-value
- dev-chrisbanes-snapper
- flogger
- napier
- reactive-streams
- rxjava
- tink
Additionally, the `Xamarin.Android.ReactiveX.RxJava` NuGet package was relying on a `<JavaSourceJar>` for some parameter names.
Add the artifact-level `documentationType` field to `config.json` that can be specified if a `<JavaSourceJar>` or `<JavaDocJar>` is needed. The default value is `none`, the values `javasource` and `javadoc` are supported.
Make 2 tweaks to the `update-config` console output. Note these do not affect anything that is written to `config.json`, just what is written to the console.
- Add number of packages and dependencies to table header:
```console
| 340 Packages (* = Has Update) | Currently Bound | Latest Stable |
|------------------------------------------------------------|-------------------|-----------------|
| androidx.activity.activity | 1.9.1 | 1.9.1 |
...
| 18 Dependencies (* = Has Update) | Current Reference | Latest Publish |
|------------------------------------------------------------|-------------------|-----------------|
| Xamarin.GooglePlayServices.Ads.Identifier | 118.1.0.1 | 118.1.0.1 |
...
```
- Show if there are updates available for "Frozen" packages. Previously it would just show as frozen and not show if there were updates available.
```console
// Previous behavior
| # com.google.android.material.material | 1.11.0 | 1.11.0 |
// New behavior
| #* com.google.android.material.material | 1.11.0 | 1.12.0 |
```
Some of the final pieces needed to start removing package-specific templates:
- We use the top level `mavenRepositoryType` to default all packages to Google's Maven, and then use the templates to override this to `MavenCentral`. Without templates we will need to specify this directly on the artifact, so add support for an artifact level `mavenRepositoryType`.
- We have several different "types" of packages that we create today:
- `EmbeddedJar` - Basic use of `<EmbeddedJar>` to include the Java payload in the NuGet package next to the managed bindings `.dll`. (This is equivalent to the preferred `<AndroidLibrary>` in .NET 6+.)
- `Targets` - Uses `<InputJar>` to create the binding `.dll` and `<None>` to add the Java payload manually into the NuGet package and uses a `.targets` file to add it to the Android application.
- `NoBindings` - Uses `<None>` to add the Java payload manually into the NuGet package and uses a `.targets` file to add it to the Android application. Does not create managed bindings.
- `XBD` - Uses `<InputJar>` to create the binding `.dll`. The Java payload is not included in the NuGet package. Instead a `.targets` file is used to download the payload at compile time using `Xamarin.Build.Download`.
The default package type is `targets`, which is what the current default template uses. That is, this is the one that all AndroidX packages currently use.
To specify a different package type, we add a new artifact level `type` attribute. The only currently supported value for this is `androidlibrary` which provides the `EmbeddedJar` package type behavior.
As a proof of concept, migrate `GoogleGson` from the `gson` template to the default template.
### Results
Before:
```json
{
"groupId": "com.google.code.gson",
"artifactId": "gson",
"version": "2.11.0",
"nugetVersion": "2.11.0.1",
"nugetId": "GoogleGson",
"dependencyOnly": false,
"templateSet": "gson"
}
```
After:
```json
{
"groupId": "com.google.code.gson",
"artifactId": "gson",
"version": "2.11.0",
"nugetVersion": "2.11.0.1",
"nugetId": "GoogleGson",
"dependencyOnly": false,
"type": "androidlibrary",
"mavenRepositoryType": "MavenCentral"
}
```
The `update-config.csx` script should no longer be used in AndroidX repository.
Instead, use one of the following:
- `dotnet cake -t=update-config`
- `dotnet cake -t=bump-config`
- `dotnet cake -t=sort-config`
- `dotnet cake -t=published-config`
Commands are documented [here](https://github.com/xamarin/AndroidX/blob/main/BUILDING.md).
Instead of manually maintaining licensing information for packages, pull the license information from the package's POM file. This information looks like:
```xml
<licenses>
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
```
We need to be able to "understand" this license and properties about it, like its SPDX identifier and whether it is proprietary or not. To do this, we match the license name to a new section in `config.json`:
```json
"licenses": [
{
"name": "The Apache Software License, Version 2.0",
"file": "templates/licenses/apache-2.0.txt",
"spdx": "Apache-2.0",
"proprietary": false
}, ...
]
```
Note there may be multiple entries for the "same" license, as different POM files may give it a slightly different name.
These license entries also point to a local copy of the license text that we can use to build `THIRD-PARTY-NOTICES.txt` when `binderator` runs.
Modify the project template to include the generated `THIRD-PARTY-NOTICES.txt` which contains the correct notices for each package rather than the generic repo `External-Dependency-Info.txt` which was not correct for packages not licensed under Apache-2.0.
Finally, if the package is open source and all its license(s) have valid SPDX identifiers, calculate the compound SPDX expression and apply it to the package with `<PackageLicenseExpression>`. If not, use `<PackageLicenseFile>` instead. (SPDX doesn't allow a "proprietary" identifier.)
Note in some cases we may not be able to automatically pull license information from the POM. In these cases we can override the POM information with a new `overrideLicenses` entry on an artifact in `config.json`:
```json
"overrideLicenses": [
"Apache 2.0|http://www.apache.org/licenses/LICENSE-2.0.txt"
],
```
The format is `{license name}|{license url}`.
In https://github.com/xamarin/AndroidX/pull/925, we converted the custom "samples" tests into NUnit unit tests, but did not remove the old tests.
Remove the `samples` directory and change the Cake targets like `ci-samples` to run the new NUnit tests.
Begin streamlining and updating the default project template. There are two goals here:
- Modernize appearance and metadata by removing "Xamarin" branding and verbiage, shifting more towards ".NET for Android" branding.
- Begin making the default project template more generic and configurable via `config.json`. The desire here is to reduce maintenance burden by making the default template flexible enough that library-specific templates (like `kotlin` or `tink`) are no longer required. (Currently we maintain 46 template sets across AndroidX and GPS repos, the majority of which only have minor differences.)
Reduce maintenance costs by creating a generic `PackageLicense.md` file that can be used by all packages. Instead of listing package-specific licensing, it points to the existing `THIRD-PARTY-NOTICES.txt` file which already contains package-specific licensing.
Additionally, this is done as `PackageLicense.md` instead of the root `LICENSE.md` because it is specific to the packages we ship and not necessarily to the code in this repository. That is, the package-specific wording does not apply to things like the `binderator` code that exists in this repository.
Also, mentions of `Xamarin` were replaced with `Microsoft`.
Finally, pull in the standard `dotnet` `LICENSE.txt` for the repository level license, a la:
- https://github.com/dotnet/runtime/blob/main/LICENSE.TXT
- https://github.com/dotnet/android/blob/main/LICENSE.TXT
There is some interesting content available in a Java `.pom` file that we can add to our package readme files:
- Developer(s)
- License(s)
- Description
- Project URL
Add this information, apply some formatting, and remove some less useful information that clutters the readme. Mockup of the new layout on nuget.org:
Other changes:
- `binderator` changes were required to pull in the new fields. Switch to the in-tree version of `binderator` instead of publishing a new `dotnet tool` version.
- Our existing `readme.md` [doesn't work on nuget.org](https://www.nuget.org/packages/Xamarin.AndroidX.Core#readme-body-tab) because we are missing the `$(PackageReadmeFile)` property. Fix this.
- This `readme.md` is intentionally generic enough to be usable by all of our packages. Remove individual template copies.
Convert our existing `BuildAllDotNet`/`BuildAllMauiApp` samples to NUnit based unit tests. These tests use `dotnet new android|maui` instead of committed projects so that we always ensure we are testing against the current templates that our users will be using.
Additionally, move these tests to another stage, so they can run in parallel with other [test suite(s)](https://github.com/xamarin/AndroidX/pull/892).
This PR does not remove the existing `BuildAll*` samples, those will be removed in a future PR.
As the scope of `update-config.csx` has grown, it has become more and more painful that it isn't in an actual project editable in an IDE, making it harder to update or debug. As it shares code with `binderator`, like reading and writing `config.json`, move the functionality into `binderator`.
To help facilitate running this functionality, add new targets to `cake` for the various operations:
* `update-config`
Updates config.json to the latest versions found in Maven.
* `bump-config`
Increments the NuGet patch version of all packages in config.json.
* `sort-config`
Sorts config.json file using the canonical sort.
* `published-config`
Shows which NuGet package versions in config.json have been published to NuGet.org.
Note these run the in-tree version of `binderator`, there is no need to install the .NET Global tool version to run these targets.
moljac
James Crutchley
Jonathan Pobst