UPM Git Extension

This package extends the UI of Unity Package Manager (UPM) for the packages installed from git repository.

<< Description | Install | Usage | Development Note >>

What's new? See changelog

Do you want to receive notifications for new releases? Watch this repo

Support me on GitHub!

Description

In Unity 2018.3, the Unity Package Manager (UPM) supported Git. :)
https://forum.unity.com/threads/git-support-on-package-manager.573673/

This update allows us to quickly install packages on code hosting services such as GitHub.
But, I'm not quite satisfied with the feature. :(

Incorrect links to documents (readme, changelog, license)
There is not a link to repo URL
I wanna add, update, and remove the packages in the UI

This project extends the UI of Unity Package Manager for package installed using git!

Features

Link to git repository URL
Link to offline documents
- Documentations
- Changelog
- License
Support GitHub, GitLab, Bitbucket, etc.
Install package from git repository URL with UI
Update package with a specific tag/branch
Remove package
Support Unity 2018.3 or later
Support .Net 4.x
Version filtering
Support GitDependencyResolverForUnity in Unity 2019.1 or later

Future plans

Display license
Support git dependency in the package
Custom package list

Install

Find Packages/manifest.json in your project and edit it to look like this:

{
  "dependencies": {
    "com.coffee.upm-git-extension": "https://github.com/mob-sakai/UpmGitExtension.git",
    ...
  },
}

Requirement

Unity 2018.3 or later
Git (executable on command-line)

Usage

Install a package from git repository

Click button in package manager UI to open Install Package Window
Input a git repository url and click Find Versions button
Select a tag or branch and click Find Package button
Wait a few seconds for validation
Click Add Package button to install the package

Update package with a specific tag or branch as version

You can update the package in your project, just like official packages.

For Unity 2019.1 or later

Select the version of the package
Click Update To *** button

For Unity 2018.3

Click version popup and select a tag or branch in repository
Click Update To button

Remove package

You can update the package from your project, just like official packages.

Click Remove button

Development Note

Develop a package for UPM

The branching strategy when I develop a package for UPM is as follows.

Branch	Description	'Assets' directory
develop	Develop, Test	Included
master	Publish with legacy way (.unitypackage)	Included
upm(default)	Subtree to publish for UPM	Excluded
{tags}	Tags to install using UPM	Excluded

Steps to release a package:

Update version in package.json.
Develop package project on develop branch.
Close all issues on GitHub for new version.
Generate CHANGELOG.md using github_changelog_generator and commit it.
Merge into master branch and publish as new version.
Split subtree into ump branch.
Tag on ump branch as new version.
Release.

For details, see https://www.patreon.com/posts/25070968.

License

Author

mob-sakai

Mefodei/UpmGitExtension