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

Clean up the package.json and add some docs #2452

Merged
merged 7 commits into from
Jun 25, 2021
Merged

Conversation

nirinchev
Copy link
Member

@nirinchev nirinchev commented Jun 17, 2021

Description

Changes how we distribute the Unity package to ILRepack its dependencies and make them internal (except for MongoDB.Bson which we have in the public API, but I don't expect it to conflict with other libraries being used in the Unity project).

ILRepacking our dependencies allows us to distribute a single package and the added managed library should be negligible compared to the native binaries and the actual game assets. If we do run into a situation where we conflict with another library referencing MongoDB.Bson, we'll have to figure out a way to distribute without it.

Overview of the changes

  • Add a Unity-specific Readme.md to Realm.Unity
  • Add Third Party notices for the libraries we're bundling
  • Modify SetupUnityPackage to copy Changelog.md and License.md to the Unity package
  • Modify SetupUnityPackage to bundle main package dependencies with ILRepack producing a single package where System.Buffers, Remotion.Linq, and so on are ILMerge-d and internalized with the Realm.dll, while MongoDB.Bson is ILMerged but still exposed.

@nirinchev nirinchev self-assigned this Jun 17, 2021
@@ -0,0 +1,42 @@
![Realm](https://github.com/realm/realm-dotnet/raw/master/logo.png)

Realm is an embedded mobile database that runs directly on phones, tablets, or desktops.
Copy link
Member Author

Choose a reason for hiding this comment

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

@mongomoe tagging you to review the Readme - this is what's going to be shown on npmjs - e.g. here: https://www.npmjs.com/package/moment as well as if the user clicks on it in the unity package manager.

@nirinchev nirinchev marked this pull request as draft June 21, 2021 23:10
@nirinchev nirinchev requested a review from LaPeste June 22, 2021 07:14
@@ -314,42 +314,18 @@
<Reference Include="Mono.Cecil">
<HintPath>C:\work\dotnet\Realm\Realm.Unity\Editor\Cecil\Mono.Cecil.dll</HintPath>
</Reference>
<Reference Include="Nito.AsyncEx.Tasks">
Copy link
Contributor

@LaPeste LaPeste Jun 22, 2021

Choose a reason for hiding this comment

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

Are these dependences gone because we, now, only do the non-bundled version of the package for unity, right? After re-reading better the description, I understand. Never mind my initial comment.

Copy link
Contributor

@LaPeste LaPeste left a comment

Choose a reason for hiding this comment

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

It's a good amount of changes but all seemed geared toward suppliying ILRepack with the dependencies you want to ILMerge in the final dll.
I don't think I should read all the specifications of ILRepack to verify each single line of the new changes. Despite this, the overall "shape" of the changes look reasonable.

@nirinchev nirinchev marked this pull request as ready for review June 25, 2021 21:22
@nirinchev nirinchev merged commit 1c51e0b into master Jun 25, 2021
@nirinchev nirinchev deleted the ni/unity-package-cleanup branch June 25, 2021 21:22
nirinchev added a commit that referenced this pull request Jul 6, 2021
* master:
  Update the AppConfiguration.Logger obsolete message (#2495)
  Add more serializer types to the preserved ones (#2489)
  Update changelog from Core (#2488)
  Build an xcframework for iOS (#2475)
  Prepare for vNext (#2487)
  Prepare for 10.2.1 (#2484)
  Fix TableKey / ObjKey conversion on Android x86 (#2477)
  Update the build manager locations (#2474)
  Clean up native resources on Unity application exit (#2467)
  Fix some native warnings (#2483)
  Don't try to get the app from a removed user (#2480)
  Use delete_files from core when deleting a Realm. (#2401)
  Fixes for the sync datatype tests (#2461)
  Clean up the package.json and add some docs (#2452)
  Run iOS tests on CI (#2405)
  Verify that objects do not belong to different realm when added to collection (#2465)
  Updated README instructions (#2459)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 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