search

braze-inc / braze-unity-sdk

Public repo for the Braze Unity SDK
https://www.braze.com
Other
28 stars 19 forks source link

[Feature]: Convert to UPM package #95

Open starikcetin opened 2 years ago

starikcetin commented 2 years ago

What problem are you facing?

I have to manually import a unityPackage file each time I need to update the SDK. This is error-prone and tedious.

Workarounds

Reverting from Git and importing on a clean slate is an option. But it is not a pretty option, since it is not always 100% reliable.

Ideal Solution

Now that you have asmdef files with release 3.8.1 (see #52), you are all set to deliver the SDK as a UPM package. You can even push it to a registry such as OpenUPM, which will make it even easier for the users.

Other Information

Benefits of delivering as a UPM package:

  1. Makes it much easier to install, remove, or update the SDK.
  2. Prevents cluttering the Assets folder, since everything will be contained under Packages/com.appboy.sdk (package name is an example).
  3. Your SDK will become read-only, so it won't be possible for users to tamper with it, and accidentally break things.
  4. Other UPM packages can list the SDK as a dependency (support depends on the registry).
  5. You can list other UPM packages as dependencies.

Overall it is just a good thing to have.

Again, I can create a PR for you that sets up the UPM package.

Note: UPM stands for Unity Package Manager. OpenUPM is a community-run registry of various UPM packages.

radixdev commented 2 years ago

Hi @starikcetin,

Apologies for the delay! I agree that this would be a beneficial way to publish our SDK and again we would gladly welcome any pull request. I've opened an internal jira ticket to move quickly on this, as before with the asmdef PR.