Skip to content

Commit 014ab88

Browse files
author
davidkline-ms
committed
update packages to contain license, notice and changelog files
1 parent 0ab5635 commit 014ab88

File tree

7 files changed

+57
-2
lines changed

7 files changed

+57
-2
lines changed

Assets/MRTK/Examples/packagetemplate.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,12 @@
3131
"Common*",
3232
"Samples~*",
3333
"StandardAssets*",
34-
"License*",
3534
"Microsoft.MixedReality.Toolkit.Examples*",
3635
"MRTK.Examples*",
37-
"package.json.meta"
36+
"package.json.meta",
37+
"LICENSE*",
38+
"NOTICE*",
39+
"CHANGELOG*"
3840
],
3941
%samples%
4042
}

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
## 2.5.1
4+
5+
[MRTK 2.5.1 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/15?closed=1)
6+
7+
## 2.5.0
8+
9+
[MRTK 2.5.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/12?closed=1)
10+
11+
## 2.4.0
12+
13+
[MRTK 2.4.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/11?closed=1)
14+
15+
## 2.3.0
16+
17+
[MRTK 2.3.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/10?closed=1)
18+
19+
## 2.2.0
20+
21+
[MRTK 2.2.0 changes](https://github.com/microsoft/MixedRealityToolkit-Unity/milestone/9?closed=1)

CHANGELOG.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
File renamed without changes.

LICENSE.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

NOTICE.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

scripts/packaging/createupmpackages.ps1

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ $packages = [ordered]@{
8383
# Beginning of the upm packaging script main section
8484
# The overall structure of this script is:
8585
#
86+
# 0) Ensure necessary documentation files (license, changelog, etc.) are copied to the appropriate location
8687
# 1) Replace the %version% token in the package.json file with the value of Version
8788
# 2) Overwrite the package.json file
8889
# 3) Create and the packages and copy to the OutputFolder
@@ -93,6 +94,11 @@ foreach ($entry in $packages.GetEnumerator()) {
9394
$packageFolder = $entry.Value
9495
$packagePath = Resolve-Path -Path "$ProjectRoot/$packageFolder"
9596

97+
# Copy license, changelog, etc. files to the package folder
98+
Copy-Item -Path "$projectRoot/LICENSE.md*" "$packagePath"
99+
Copy-Item -Path "$projectRoot/NOTICE.md*" "$packagePath"
100+
Copy-Item -Path "$projectRoot/CHANGELOG.md*" "$packagePath"
101+
96102
# Switch to the folder containing the package.json file
97103
Set-Location $packagePath
98104

@@ -168,6 +174,11 @@ foreach ($entry in $packages.GetEnumerator()) {
168174
Start-Process -FilePath "git" -ArgumentList "checkout Services/SceneSystem/SceneSystemResources*" -NoNewWindow -Wait
169175
}
170176

177+
# Delete the license, changelog, etc. files
178+
Remove-Item -Path "$packagePath/LICENSE.md*"
179+
Remove-Item -Path "$packagePath/NOTICE.md*"
180+
Remove-Item -Path "$packagePath/CHANGELOG.md*"
181+
171182
# Delete the renamed package.json.* files
172183
Remove-Item -Path "$packagePath/package.json"
173184
Remove-Item -Path "$packagePath/package.json.meta"

0 commit comments

Comments
 (0)