Merge pull request #8786 from davidkline-ms/upmManifestLinks

David Kline · web-flow · commit 1bc1b0ae255c · 2020-10-13T10:57:04.000-07:00
Add license and changelog files to the UPM packages
diff --git a/Assets/MRTK/Examples/Experimental/ExamplesHub/Profiles/MRTKExamplesHubSceneSystemProfile.asset b/Assets/MRTK/Examples/Experimental/ExamplesHub/Profiles/MRTKExamplesHubSceneSystemProfile.asset
@@ -16,7 +16,7 @@ MonoBehaviour:
   useManagerScene: 0
   managerScene:
     Name: DefaultManagerScene
-    Path: Assets/MRTK/SceneSystemResources/DefaultManagerScene.unity
+    Path: Assets/MRTK/Services/SceneSystem/SceneSystemResources/DefaultManagerScene.unity
     Included: 0
     BuildIndex: -1
     Tag: Untagged
@@ -25,7 +25,7 @@ MonoBehaviour:
   defaultLightingSceneIndex: 0
   lightingScenes:
   - Name: DefaultLightingScene
-    Path: Assets/MRTK/SceneSystemResources/DefaultLightingScene.unity
+    Path: Assets/MRTK/Services/SceneSystem/SceneSystemResources/DefaultLightingScene.unity
     Included: 0
     BuildIndex: -1
     Tag: Untagged
diff --git a/Assets/MRTK/Examples/packagetemplate.json b/Assets/MRTK/Examples/packagetemplate.json
@@ -29,12 +29,15 @@
     },
     "files": [
         "Common*",
-        "Samples~*",
         "StandardAssets*",
-        "License*",
         "Microsoft.MixedReality.Toolkit.Examples*",
         "MRTK.Examples*",
-        "package.json.meta"
+        "package.json.meta",
+        "LICENSE*",
+        "NOTICE*",
+        "CHANGELOG*",
+        "Documentation~*",
+        "Samples~*"
     ],
     %samples%
 }
diff --git a/Assets/MRTK/SDK/Profiles/DefaultMixedRealitySceneSystemProfile.asset b/Assets/MRTK/SDK/Profiles/DefaultMixedRealitySceneSystemProfile.asset
@@ -16,7 +16,7 @@ MonoBehaviour:
   useManagerScene: 1
   managerScene:
     Name: DefaultManagerScene
-    Path: Assets/MRTK/SceneSystemResources/DefaultManagerScene.unity
+    Path: Assets/MRTK/Services/SceneSystem/SceneSystemResources/DefaultManagerScene.unity
     Included: 0
     BuildIndex: -1
     Tag: Untagged
@@ -25,7 +25,7 @@ MonoBehaviour:
   defaultLightingSceneIndex: 0
   lightingScenes:
   - Name: DefaultLightingScene
-    Path: Assets/MRTK/SceneSystemResources/DefaultLightingScene.unity
+    Path: Assets/MRTK/Services/SceneSystem/SceneSystemResources/DefaultLightingScene.unity
     Included: 0
     BuildIndex: -1
     Tag: Untagged
diff --git a/Assets/MRTK/packagetemplate.json b/Assets/MRTK/packagetemplate.json
@@ -32,6 +32,10 @@
         "SDK*",
         "Services*",
         "package.json.meta",
+        "LICENSE*",
+        "NOTICE*",
+        "CHANGELOG*",
+        "Documentation~*",
         "Samples~"
     ],
     "samples": [
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,21 @@
+# Changelog
+
+## 2.5.1
+
+[MRTK 2.5.1 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/15?closed=1)
+
+## 2.5.0
+
+[MRTK 2.5.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/12?closed=1)
+
+## 2.4.0
+
+[MRTK 2.4.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11?closed=1)
+
+## 2.3.0
+
+[MRTK 2.3.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/10?closed=1)
+
+## 2.2.0
+
+[MRTK 2.2.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/9?closed=1)
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/UPM/Documentation~/README.md b/UPM/Documentation~/README.md
@@ -0,0 +1,4 @@
+# Microsoft Mixed Reality Toolkit
+
+[Getting Started](https://docs.microsoft.com/en-us/windows/mixed-reality/develop/unity/mrtk-getting-started)
+[MRTK Documentation on GitHub](https://microsoft.github.io/MixedRealityToolkit-Unity/README.html)
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.examples b/UPM/UnityMetaFiles/CHANGELOG.md.meta.examples
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 5c6da385821e18e4190cfb264e69e6c0
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.extensions b/UPM/UnityMetaFiles/CHANGELOG.md.meta.extensions
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 89881a5c5dfca7040bd4d240690ecd5a
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.foundation b/UPM/UnityMetaFiles/CHANGELOG.md.meta.foundation
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 4d3d415154baf7f429edd9dc550990e6
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.standardassets b/UPM/UnityMetaFiles/CHANGELOG.md.meta.standardassets
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: a0829ffee66e1dc459348c774dee10d1
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.testutilities b/UPM/UnityMetaFiles/CHANGELOG.md.meta.testutilities
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 24adf595f190b5f4881bf36a1c812ca9
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/CHANGELOG.md.meta.tools b/UPM/UnityMetaFiles/CHANGELOG.md.meta.tools
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 743a62f0d31662b4581f1e9d1aca4f5d
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.examples b/UPM/UnityMetaFiles/LICENSE.md.meta.examples
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: edd2997b549710c4b83156089b1ba3d9
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.extensions b/UPM/UnityMetaFiles/LICENSE.md.meta.extensions
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 5b58642746232d54dbfd8860b771b777
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.foundation b/UPM/UnityMetaFiles/LICENSE.md.meta.foundation
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 1d48399c6fe640f428cd6271e2f6b9e5
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.standardassets b/UPM/UnityMetaFiles/LICENSE.md.meta.standardassets
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 1594ddaebf11f1b40adc54fb6d6a2da5
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.testutilities b/UPM/UnityMetaFiles/LICENSE.md.meta.testutilities
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 5b269c4053973f24d829ea8f284932e6
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/LICENSE.md.meta.tools b/UPM/UnityMetaFiles/LICENSE.md.meta.tools
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: c538b433b95920847a1a6e1f936a1fb9
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.examples b/UPM/UnityMetaFiles/NOTICE.md.meta.examples
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: c5459736aaa829a42b0fce4d05266f06
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.extensions b/UPM/UnityMetaFiles/NOTICE.md.meta.extensions
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 7d0b3383292383c439bef4aa7deb7ddf
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.foundation b/UPM/UnityMetaFiles/NOTICE.md.meta.foundation
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 30eea000247723e4c9fda0d4b4b40785
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.standardassets b/UPM/UnityMetaFiles/NOTICE.md.meta.standardassets
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 2dee3c60884c44545b0733868dafcb59
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.testutilities b/UPM/UnityMetaFiles/NOTICE.md.meta.testutilities
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 2ed3cae4a0af31746895a09c301548f9
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/UPM/UnityMetaFiles/NOTICE.md.meta.tools b/UPM/UnityMetaFiles/NOTICE.md.meta.tools
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: cdb0f77fe63ed9743ad6ce60ca803c3d
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 
diff --git a/scripts/packaging/createupmpackages.ps1 b/scripts/packaging/createupmpackages.ps1
@@ -75,18 +75,19 @@ $packages = [ordered]@{
     # tools
     "tools" = "Assets/MRTK/Tools";
     # tests
-    "testutilties" = "Assets/MRTK/Tests/TestUtilities";
+    "testutilities" = "Assets/MRTK/Tests/TestUtilities";
     # examples
     "examples" = "Assets/MRTK/Examples";
 }
 
 # Beginning of the upm packaging script main section
 # The overall structure of this script is:
 #
-# 1) Replace the %version% token in the package.json file with the value of Version
-# 2) Overwrite the package.json file
-# 3) Create and the packages and copy to the OutputFolder
-# 4) Cleanup files created and/or modified
+# * Ensure necessary documentation files (license, changelog, etc.) are copied to the appropriate location
+# * Replace the %version% token in the package.json file with the value of Version
+# * Overwrite the package.json file
+# * Create and the packages and copy to the OutputFolder
+# * Cleanup files created and/or modified
 
 # Create and publish the packages
 foreach ($entry in $packages.GetEnumerator()) {
@@ -110,6 +111,17 @@ foreach ($entry in $packages.GetEnumerator()) {
     # Create and publish the package
     $packageName = $entry.Name
 
+    $docFolder = "$packagePath/Documentation~"
+
+    # Copy files used by UPM to display license, change log, etc.
+    Copy-Item -Path "$projectRoot/LICENSE.md" "$packagePath"
+    Copy-Item -Path "$projectRoot/UPM/UnityMetaFiles/LICENSE.md.meta.$packageName" "$packagePath/LICENSE.md.meta"
+    Copy-Item -Path "$projectRoot/NOTICE.md" "$packagePath"
+    Copy-Item -Path "$projectRoot/UPM/UnityMetaFiles/NOTICE.md.meta.$packageName" "$packagePath/NOTICE.md.meta"
+    Copy-Item -Path "$projectRoot/CHANGELOG.md" "$packagePath"
+    Copy-Item -Path "$projectRoot/UPM/UnityMetaFiles/CHANGELOG.md.meta.$packageName" "$packagePath/CHANGELOG.md.meta"
+    Copy-Item -Path "$projectRoot/UPM/Documentation~" $docFolder -Recurse
+ 
     $samplesFolder = "$packagePath/Samples~"
 
     if ($packageName -eq "foundation") {
@@ -168,11 +180,20 @@ foreach ($entry in $packages.GetEnumerator()) {
         Start-Process -FilePath "git" -ArgumentList "checkout Services/SceneSystem/SceneSystemResources*" -NoNewWindow -Wait
     }
 
+    # Delete the files copied in previously
+    Remove-Item -Path "$packagePath/LICENSE.md*"
+    Remove-Item -Path "$packagePath/NOTICE.md*"
+    Remove-Item -Path "$packagePath/CHANGELOG.md*"
+    if (Test-Path -Path $docFolder) {
+        # A documentation folder was created. Remove it.
+        Remove-Item -Path $docFolder -Recurse -Force
+    }
+
     # Delete the renamed package.json.* files
     Remove-Item -Path "$packagePath/package.json"
     Remove-Item -Path "$packagePath/package.json.meta"
 
-    # Restore the original template files
+    # Restore original files
     Start-Process -FilePath "git" -ArgumentList "checkout packagetemplate.*" -NoNewWindow -Wait
 }
 
