Upm Git Extension by mob-sakai - 19

ToolsExtensions

Git extension for Unity Package Manager (UPM)

MIT LicenseUpdated 3 days agoCreated on January 8th, 2019

UPM Git Extension

Git extension for Unity Package Manager (UPM)

PRs Welcome

<< Description | WebGL Demo | Download | Usage | Development Note >>

What’s new? See changelog

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

Support me on Patreon! become_a_patron





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

  • Show link to repository URL
  • Override link to the document URL
    • Readme
    • Changelog
    • License
  • Support GitHub, Bitbucket and GitLab
  • Add package from url
  • Remove package
  • Update package with a specific tag/branch
  • Support Unity 2019.1+
  • Support .Net 3.5 & 4.x

Future plans

  • View offline documents for private repository
  • Display license
  • Override the document URL with package.json





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#0.8.1",
    ...
  },
}

For Unity 2019.1+, use UpmGitExtension 0.5.0 or higher.

Requirement
  • Unity 2018.3+ (including 2019.1+)





Usage

Add package from url

  1. Click + button and select Add package from url to open window
  2. Input repository url and select a tag or branch
  3. Wait a few seconds for validation
  4. Click Add button to add package

Update package with a specific tag/branch

  1. Click version popup and select a tag/branch in repository
  2. Click Update To button

Remove package

  1. 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 Development, Testing Included
master Publishing Included
upm(default) Subtree to publish for UPM Excluded
{tags} Tags to install using UPM Excluded

Steps to release a package:

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

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

About default document URL

The document URL in UnityPackageManager 2.0.3 is hard-coded.
The default values are as follows:

  • View document: http://docs.unity3d.com/Packages/{ShortVersionId}/index.html or official manual page (only for built in package)
  • View changelog: http://docs.unity3d.com/Packages/{ShortVersionId}/changelog/CHANGELOG.html
  • View licenses: http://docs.unity3d.com/Packages/{ShortVersionId}/license/index.html or https://unity3d.com/legal/licenses/Unity_Companion_License

ShortVersionId is defined as follows:

How to add/update/remove a package from script?

Use UnityEditor.PackageManager.Client class.
https://docs.unity3d.com/ScriptReference/PackageManager.Client.html

  • Add/Update: Client.Add({PackageId})
  • Remove: Client.Remove({PackageName})

PackageId is defined as follows:

  • {PackageName}@{MajorVersion}.{MinorVersion}.{PatchVersion} (Unity official package)
  • {PackageName}@{RepoURL}#{BranchOrTagOrRevision}
  • For example: [email protected], coffee[email protected]://github.com/mob-sakai/UpmGitExtension.git#1.1.1





License

  • MIT

Author

mob-sakai
become_a_patron

See Also

Show all projects by mob-sakai