Skip to content

Commit

Permalink
fix(ci): back to npmjs.com
Browse files Browse the repository at this point in the history
GitHub's npm feeds only allow publishing scoped packages, but UPM
doesn't support those.
  • Loading branch information
Christopher - Marcel Böddecker committed Oct 14, 2019
1 parent d528cc8 commit 563988f
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .devops/azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ resources:
- repository: templates
type: github
name: ExtendRealityLtd/DevOps
ref: refs/tags/v3.11.3
ref: refs/tags/v3.11.6
endpoint: ExtendRealityLtd

variables:
Expand Down
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,33 @@ Releases follow the [Semantic Versioning (SemVer) system][SemVer].

## Getting Started

Please follow these steps to install the package using a local location until the Unity Package Manager (UPM) allows third parties to publish packages to the UPM feed:

1. Download a release from the [Releases] page and extract it into your folder you use to keep your packages. It is recommended to make that folder part of your project and therefore [version controlled][VCS].
1. Open your project created with the Unity software version 2018.3 (or above) and follow [Unity's instructions][UPM-Instructions] on how to add the package to your project using UPM.
1. Anywhere in your Unity software project add a [`FodyWeavers.xml` file][FodyWeavers].
1. Configure the various weavers Malimbe offers, e.g.:
* Navigate to the `Packages` directory of your project.
* Adjust the [project manifest file][Project-Manifest] `manifest.json` in a text editor.
* Ensure `https://registry.npmjs.org/` is part of `scopedRegistries`.
* Ensure `io.extendreality` is part of `scopes`.
* Add `io.extendreality.malimbe` to `dependencies`, stating the latest version.

A minimal example ends up looking like this. Please note that the version `X.Y.Z` stated here is to be replaced with [the latest released version][Latest-Release].
```json
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"io.extendreality"
]
}
],
"dependencies": {
"io.extendreality.malimbe": "X.Y.Z",
...
}
}
```
* Switch back to the Unity software and wait for it to finish importing the added package.
* Anywhere in your Unity software project add a [`FodyWeavers.xml` file][FodyWeavers].
* Configure the various weavers Malimbe offers, e.g.:
```xml
<?xml version="1.0" encoding="utf-8"?>

Expand Down Expand Up @@ -88,6 +109,7 @@ These materials are not sponsored by or affiliated with Unity Technologies or it
[Backlog]: http://tracker.vrtk.io
[Releases]: ../../releases
[SemVer]: https://semver.org/
[Latest-Release]: https://github.com/ExtendRealityLtd/Malimbe/releases/latest
[VCS]: https://en.wikipedia.org/wiki/Version_control
[UPM-Instructions]: https://docs.unity3d.com/Packages/[email protected]/manual/index.html#extpkg
[FodyWeavers]: https://github.com/Fody/Fody#add-fodyweaversxml
Expand Down
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@extendrealityltd/malimbe",
"name": "io.extendreality.malimbe",
"displayName": "Malimbe",
"description": "A collection of tools to simplify writing public API components in Unity.",
"version": "9.5.0",
Expand All @@ -14,7 +14,10 @@
"bugs": {
"url": "https://github.com/ExtendRealityLtd/Malimbe/issues"
},
"repository": "github:ExtendRealityLtd/Malimbe",
"repository": {
"type": "git",
"url": "ssh://[email protected]/ExtendRealityLtd/Malimbe.git"
},
"license": "MIT",
"author": {
"name": "Extend Reality Ltd",
Expand All @@ -30,4 +33,4 @@
"scripts": {
"prepack": "cp -rf Sources/UnityPackaging/bin/Release/* ."
}
}
}

0 comments on commit 563988f

Please sign in to comment.