feat(distribution): library now requires Unity Package Manager to run

ashblue · ashblue · commit f48f9015de22 · 2019-11-17T11:11:08.000-07:00
BREAKING CHANGE: You now must use Unity's Package Manager to install this package. See the `###
Installation` section in the README.md for full details.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false
+
+[manifest.json]
+indent_size = 2
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,8 @@
 /[Oo]bj/
 /[Bb]uild/
 /[Bb]uilds/
-/Assets/AssetStoreTools*
+/[Ll]ogs/
+/[Mm]emoryCaptures/
 
 # Visual Studio 2015 cache directory
 /.vs/
@@ -31,3 +32,8 @@ sysinfo.txt
 
 # Builds
 *.apk
+
+# Node.js
+node_modules
+dist
+dist.zip
diff --git a/.releaserc b/.releaserc
@@ -0,0 +1,32 @@
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/exec",
+      {
+        "verifyConditionsCmd": "npm run build",
+        "prepareCmd": "npm run build"
+      }
+    ],
+    "@semantic-release/git",
+    [
+      "@semantic-release/npm",
+      {
+        "pkgRoot": "dist"
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": [
+          {
+            "path": "dist.zip",
+            "label": "Package Build"
+          }
+        ]
+      }
+    ]
+  ]
+}
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,15 @@
+language: node_js
+node_js:
+  - "node"
+install:
+  - npm install
+script:
+  - commitlint-travis
+  - npm run build
+  - npm run semantic-release
+deploy:
+  - provider: script
+    skip_cleanup: true
+    script: bash publish-nightly.sh
+    on:
+      branch: develop
diff --git a/Assets/com.fluid.unity-animator-helpers/CHANGELOG.md b/Assets/com.fluid.unity-animator-helpers/CHANGELOG.md
@@ -0,0 +1 @@
+Replaced when project is built from commit logs via Semantic Release.
diff --git a/Assets/com.fluid.unity-animator-helpers/Documentation~/com.fluid.unity-animator-helpers.md b/Assets/com.fluid.unity-animator-helpers/Documentation~/com.fluid.unity-animator-helpers.md
@@ -0,0 +1 @@
+Documentation beyond README.md goes here.
diff --git a/Assets/com.fluid.unity-animator-helpers/Editor/com.fluid.unity-animator-helpers.Editor.asmdef b/Assets/com.fluid.unity-animator-helpers/Editor/com.fluid.unity-animator-helpers.Editor.asmdef
@@ -0,0 +1,12 @@
+{
+    "name": "com.fluid.unity-animator-helpers.Editor",
+    "references": [
+        "com.fluid.unity-animator-helpers"
+    ],
+    "optionalUnityReferences": [],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false
+}
diff --git a/Assets/com.fluid.unity-animator-helpers/LICENSE.md b/Assets/com.fluid.unity-animator-helpers/LICENSE.md
@@ -0,0 +1 @@
+Edit LICENSE.md in root, contents will be replaced.
diff --git a/Assets/com.fluid.unity-animator-helpers/README.md b/Assets/com.fluid.unity-animator-helpers/README.md
@@ -0,0 +1 @@
+Edit README.md in root, contents will be replaced.
diff --git a/Assets/com.fluid.unity-animator-helpers/Runtime/com.fluid.unity-animator-helpers.asmdef b/Assets/com.fluid.unity-animator-helpers/Runtime/com.fluid.unity-animator-helpers.asmdef
@@ -0,0 +1,7 @@
+{
+    "name": "com.fluid.unity-animator-helpers",
+    "references": [],
+    "optionalUnityReferences": [],
+    "includePlatforms": [],
+    "excludePlatforms": []
+}
diff --git a/Assets/com.fluid.unity-animator-helpers/Tests/Editor/com.fluid.unity-animator-helpers.Editor.Tests.asmdef b/Assets/com.fluid.unity-animator-helpers/Tests/Editor/com.fluid.unity-animator-helpers.Editor.Tests.asmdef
@@ -0,0 +1,19 @@
+{
+    "name": "com.fluid.unity-animator-helpers.Editor.Tests",
+    "references": [
+        "com.fluid.unity-animator-helpers",
+        "com.fluid.unity-animator-helpers.Editor"
+    ],
+    "optionalUnityReferences": [
+        "TestAssemblies"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": []
+}
diff --git a/Assets/com.fluid.unity-animator-helpers/Tests/Runtime/com.fluid.unity-animator-helpers.Tests.asmdef b/Assets/com.fluid.unity-animator-helpers/Tests/Runtime/com.fluid.unity-animator-helpers.Tests.asmdef
@@ -0,0 +1,16 @@
+{
+    "name": "com.fluid.unity-animator-helpers.Tests",
+    "references": [
+        "com.fluid.unity-animator-helpers"
+    ],
+    "optionalUnityReferences": [
+        "TestAssemblies"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": []
+}
diff --git a/Assets/com.fluid.unity-animator-helpers/package.json b/Assets/com.fluid.unity-animator-helpers/package.json
@@ -0,0 +1,7 @@
+{
+  "name": "com.fluid.unity-animator-helpers",
+  "version": "0.0.0",
+  "displayName": "Unity Animator Helpers",
+  "description": "A set of Animator helper scripts to better streamline and handle animation playback",
+  "unity": "2019.1"
+}
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ash Blue
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -7,10 +7,7 @@ Ever had to handle complex animations that require multiple frames such as jump,
 * Wait for multiple animator variable changes from a coroutine or loop
 * Pre-made library of common Animator Behaviors for visually programming the Animator with variable changes and randomization  
 
-## Quick Start Guide
-
-Grab the export package and import it into your Unity project
- [Assets/Dist/AdncAnimatorHelpers.unitypackage](/Assets/Dist/AdncAnimatorHelpers.unitypackage)
+## Quickstart
 
 ### AnimatorPlayback Objects
 
@@ -56,30 +53,82 @@ public class AnimatorPlaybackExample : MonoBehaviour {
 Note that the AnimatorPlayback objects are fully unit and runtime tested
 due to their level of complexity.
 
-### Features
+#### Features
    
    * AnimatorPlayback objects to easily detect animation completion conditions
    * Pre-built library on AnimatorBehavior(s) for complex animation playback
    * Animator extensions that add missing functionality to Unity's Animator component
    * Animator unit testing helper (for editor only tests)
    * Unit tested
 
-#### Requesting Features
+### Installation
+
+Unity Animator Helpers is used through [Unity's Package Manager](https://docs.unity3d.com/Manual/CustomPackages.html). In order to use it you'll need to add the following lines to your `Packages/manifest.json` file. After that you'll be able to visually control what specific version of Unity Animator Helpers you're using from the package manager window in Unity. This has to be done so your Unity editor can connect to NPM's package registry.
+
+```json
+{
+  "scopedRegistries": [
+    {
+      "name": "NPM",
+      "url": "https://registry.npmjs.org",
+      "scopes": [
+        "com.fluid"
+      ]
+    }
+  ],
+  "dependencies": {
+    "com.fluid.unity-animator-helpers": "2.0.0"
+  }
+}
+```
+
+### Releases
 
-Please file a GitHub [issue ticket](https://github.com/ashblue/unity-animator-helpers/issues) if you'd like to 
-request a feature.
+Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/unity-animator-helpers/releases).
+
+#### Nightly Builds
+
+To access nightly builds of the `develop` branch that are package manager friendly, you'll need to manually edit your `Packages/manifest.json` as so. 
+
+```json
+{
+    "dependencies": {
+      "com.fluid.unity-animator-helpers": "https://github.com/ashblue/unity-animator-helpers.git#nightly"
+    }
+}
+```
 
-You can view the current [roadmap here](https://github.com/ashblue/unity-animator-helpers/projects/1).
+Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
 
-## Animator Behaviors
+### Development Environment
+
+If you wish to run to run the development environment you'll need to install the latest [node.js](https://nodejs.org/en/). Then run the following from the root once.
+
+`npm install`
+
+If you wish to create a build run `npm run build` from the root and it will populate the `dist` folder.
+
+#### Making Commits
+
+All commits should be made using [Commitizen](https://github.com/commitizen/cz-cli) (which is automatically installed when running `npm install`). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected.
+
+To make a commit type the following into a terminal from the root
+
+```bash
+npm run commit
+```
+
+## Other Helper Libraries
+
+### Animator Behaviors
 
 There are several animator helper scripts to assist you with Animator Behavior(s).
 These are aimed at allowing you to interact with the Animator without having to write
 additional scripts to tweak variables and playback.
 
 ![Preview of Playback Helper](/animator-helpers.png)
 
-### Available Helpers
+#### Available Helpers
 
 Here is a brief list of helpers. New ones will be added as the repo is updated over time.
 
@@ -94,7 +143,7 @@ Here is a brief list of helpers. New ones will be added as the repo is updated o
 
 See documentation on methods (in code) for complete details.
 
-## Animator Extensions
+### Animator Extensions
 
 Unity Animator Helpers extends the pre-existing functionality of Unity3D's built in `Animator` component with static
 extensions. This doesn't hurt or break any existing functionality. For example you could do the following to check if 
@@ -114,7 +163,7 @@ public class AnimatorExtensionExample : MonoBehaviour {
 }
 ``` 
 
-### Available Animator extensions
+#### Available Animator extensions
 
 * HasParameter(name)
 * HasBool(name)
@@ -131,7 +180,7 @@ You may need to call `AnimatorHelperRuntime.Instance.Cache(Animator)` on `Start`
 have over 300 parameters. Please note that your `AnimatorController` object (what you pass into the Animator via 
 inspector) must be uniquely named in order for the caching to work correctly.
 
-## Animator Unit Test Helper
+### Animator Unit Test Helper
 
 This library provides an `AnimatorStub` (editor only) class that makes testing animations via pure code super simple.
 All you need to do is the following.
@@ -169,3 +218,7 @@ public class TestAnimatorStub {
     }
 }
 ```
+
+---
+
+This project was generated with [Oyster Package Generator](https://github.com/ashblue/oyster-package-generator).
diff --git a/build.js b/build.js
@@ -0,0 +1,3 @@
+const createDist = require('upm-package-populator');
+
+createDist('Assets/com.fluid.unity-animator-helpers', '.', 'dist');
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/publish-nightly.sh b/publish-nightly.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Replaced when project is built from commit logs via Semantic Release.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Documentation beyond README.md goes here.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Edit LICENSE.md in root, contents will be replaced.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Edit README.md in root, contents will be replaced.`