Updated release notes

sschmid · Aug 27, 2015 · 68d4a87 · 68d4a87
1 parent e3638b0
commit 68d4a87
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 5 deletions.
diff --git a/Entitas.Unity.CodeGenerator/Assets/Libraries/Entitas/entitas_version b/Entitas.Unity.CodeGenerator/Assets/Libraries/Entitas/entitas_version
@@ -1 +1 @@
-0.21.0
+0.22.0
diff --git a/Entitas.Unity.VisualDebugging/Assets/Libraries/Entitas/entitas_version b/Entitas.Unity.VisualDebugging/Assets/Libraries/Entitas/entitas_version
@@ -1 +1 @@
-0.21.0
+0.22.0
diff --git a/Entitas.Unity/Assets/Libraries/Entitas/entitas_version b/Entitas.Unity/Assets/Libraries/Entitas/entitas_version
@@ -1 +1 @@
-0.21.0
+0.22.0
diff --git a/Entitas/Entitas/entitas_version b/Entitas/Entitas/entitas_version
@@ -1 +1 @@
-0.21.0
+0.22.0
diff --git a/EntitasUpgradeGuide.md b/EntitasUpgradeGuide.md
@@ -1,3 +1,24 @@
+# Entitas 0.22.0 upgrade guide
+Entitas 0.22.0 changed IReactiveSystem and IMultiReactiveSystem and renamed IStartSystem.Start to IInitializeSystem.Initialize.
+
+Use the command line tool `MigrationAssistant.exe` to automatically migrate IReactiveSystem.
+
+```
+$ mono MigrationAssistant.exe
+usage:
+[-l]             - print all available versions
+[version] [path] - apply migration of version [version] to source files located at [path]
+
+$ mono MigrationAssistant.exe -l
+0.18.0 - Migrates IReactiveSystem GetXyz methods to getters
+0.19.0 - Migrates IReactiveSystem.Execute to accept List<Entity>
+0.22.0 - Migrates IReactiveSystem to combine trigger and eventTypes to TriggerOnEvent
+
+// Example from Math-One example project, where all the systems are located in the Features folder
+$ mono MigrationAssistant.exe 0.22.0 /Path/To/Project/Assets/Sources/Features
+```
+
+
 # Entitas 0.19.0 upgrade guide
 Entitas 0.19.0 introduces a few breaking changes:
 

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,3 +1,39 @@
+# 0.22.0
+
+##### Breaking changes
+Please follow the [Entitas upgrade guide](https://github.com/sschmid/Entitas-CSharp/blob/master/EntitasUpgradeGuide.md)
+
+- Entitas
+  - Restored previous pool.DestroyEntity() behaviour
+  - IReactiveSystem and IMultiReactiveSystem changed and use `TriggerOnEvent`
+  - Use the command line tool `MigrationAssistant.exe` to automatically migrate IReactiveSystem
+  - Renamed IStartSystem.Start to IInitializeSystem.Initialize (#21)
+
+##### Fixes
+- Entitas
+  - e.RemoveAllComponents() updates toString cache, even if entity has no components
+
+##### Entitas
+- Added AERC (Automatic Entity Reference Counting) (#30, solves #25)
+- Reduced gc allocations in e.RemoveAllComponents()
+- Reduced gc allocations in pool.CreateEntity() and pool.DestroyEntity()
+- pool.DestroyEntity() will clean suscribed event delegates of entities (#27)
+- entity.ToString() will always use component type
+- Streamlined and refactored tests and sources
+
+##### Entitas.Unity.VisualDebugging
+- Improved SystemMonitorEditor graph performance (#14)
+
+#### Entitas.Migration
+- Added M0220 (Migrates IReactiveSystem to combine trigger and eventTypes to TriggerOnEvent)
+- Updated migration descriptions
+
+##### Other
+- Removed project files
+- Renamed updateDependencies.sh to updateProjects.sh
+- buildPackage.sh includes EntitasUpgradeGuide.md in Entitas.zip
+
+
 # 0.21.0
 
 ##### Fixes
@@ -12,7 +48,6 @@
     - ReactiveSystem doesn't pass on destroyed entities anymore
 - ReactiveSystem doesn't call Execute() when filtered entities.Count == 0
 
-
 ##### Other
 - Added project files (#18)
 

diff --git a/bin/Entitas.zip b/bin/Entitas.zip